Доставки вебхуков

Что ушло на адрес, что ждёт повтора и что не доставлено, с ответами получателя; доставку можно повторить.

Загружаем поисковый индекс…

Доставки вебхуков

Объекты

WebhookDelivery

  • idintegerобязательно

    ID записи, уникальный среди записей своего вида в магазине.

  • endpoint_idintegerобязательно

    ID адреса вебхука.

  • event_idinteger или nullобязательно

    ID события в GET /v1/events, он же webhook-id доставки; null у тестового события.

  • event_typestringобязательно

    Тип события; ping — тестовое событие.

  • statusstringобязательно

    pending — ждёт попытки; succeeded — получатель ответил 2xx; failed — повторы исчерпаны.

    Значения:
    pendingsucceededfailed
  • attempt_countintegerобязательно

    Сделано попыток.

  • next_attempt_atstring (date-time) или nullобязательно

    Когда следующая попытка; null, если доставка закрыта.

  • last_attemptobject или null

    Последняя попытка; null до первой. Только в списке.

    Поля · 7
    • numberintegerобязательно

      Номер попытки, с 1.

    • manualbooleanобязательно

      Попытка по запросу повтора, а не по расписанию.

    • started_atstring (date-time)обязательно

      Когда попытка началась.

    • duration_msintegerобязательно

      Сколько длилась попытка, в миллисекундах.

    • response_statusinteger или nullобязательно

      HTTP-статус ответа получателя; null, если ответа не было.

    • response_bodystring или nullобязательно

      Начало тела ответа получателя; null, если тела не было.

    • errorstring или nullобязательно

      Почему попытка не удалась; null, если получатель ответил 2xx. redirect — ответ 3xx, редиректы не выполняются; http_error — другой статус; timeout — ответа не было 10 секунд; tls, connection, dns, unreachable — сеть; blocked — адрес ведёт во внутреннюю сеть; invalid_url — адрес не проходит проверку.

      Значения:
      invalid_urlblockeddnsconnectiontlstimeoutunreachableredirecthttp_errornull
  • attemptsмассив object

    Все попытки по порядку. Только у одной доставки.

    Поля · 7
    • numberintegerобязательно

      Номер попытки, с 1.

    • manualbooleanобязательно

      Попытка по запросу повтора, а не по расписанию.

    • started_atstring (date-time)обязательно

      Когда попытка началась.

    • duration_msintegerобязательно

      Сколько длилась попытка, в миллисекундах.

    • response_statusinteger или nullобязательно

      HTTP-статус ответа получателя; null, если ответа не было.

    • response_bodystring или nullобязательно

      Начало тела ответа получателя; null, если тела не было.

    • errorstring или nullобязательно

      Почему попытка не удалась; null, если получатель ответил 2xx. redirect — ответ 3xx, редиректы не выполняются; http_error — другой статус; timeout — ответа не было 10 секунд; tls, connection, dns, unreachable — сеть; blocked — адрес ведёт во внутреннюю сеть; invalid_url — адрес не проходит проверку.

      Значения:
      invalid_urlblockeddnsconnectiontlstimeoutunreachableredirecthttp_errornull
  • created_atstring (date-time)обязательно

    Когда запись создана.

  • updated_atstring (date-time)обязательно

    Когда запись менялась последний раз.

Методы

Доставки адреса вебхука: что ушло, что ждёт повтора, что не доставлено

get/webhook-endpoints/{endpoint}/deliveries

Scope: webhooks:read

Параметры

Путь

  • endpointintegerобязательно

    ID адреса вебхука.

Строка запроса

  • limitinteger

    Размер страницы: до 250 записей; по умолчанию 50.

    Минимум:
    1
    Максимум:
    250
  • cursorstring

    Непрозрачный курсор: next_cursor предыдущей страницы или sync_cursor последней страницы, сохранённый прошлой синхронизацией. Список идёт в порядке коммитов, поэтому курсор синхронизации позже отдаёт только изменённое после него.

    Макс. длина:
    4096
  • updated_sincestring (date-time)

    Только записи, изменённые после этого момента, ISO 8601 с часовым поясом. Фильтр первой синхронизации; дальше — курсор.

    Шаблон:
    ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
  • statusstring

    Только доставки в этом статусе.

    Значения:
    pendingsucceededfailed

Ответы

200Успешно

application/json

  • dataмассив WebhookDeliveryобязательно

    Записи страницы.

  • deletedмассив objectобязательно

    Записи, стёртые из базы с момента курсора, отметками об удалении: только с include_deleted=true в продолжении по курсору синхронизации.

    Поля · 2
    • idintegerобязательно

      ID стёртой записи.

    • deleted_atstring (date-time)обязательно

      Когда запись стёрта.

  • next_cursorstring или nullобязательно

    Курсор следующей страницы; null на последней.

  • has_morebooleanобязательно

    true, если есть следующая страница.

  • sync_cursorstring или nullобязательно

    На последней странице — курсор, с которого продолжить позже: по нему придёт только изменённое после этой страницы. null на остальных.

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

404Объекта нет или он недоступен приложению

application/problem+json

Возвращает Problem

410Курсор синхронизации старше срока хранения удалений или выдан до восстановления базы

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl "https://api.saleya.app/v1/webhook-endpoints/{endpoint}/deliveries" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "data": [
    {
      "id": 0,
      "endpoint_id": 0,
      "event_id": 0,
      "event_type": "string",
      "status": "pending",
      "attempt_count": 0,
      "next_attempt_at": "2026-01-15T12:00:00Z",
      "last_attempt": {
        "number": 0,
        "manual": true,
        "started_at": "2026-01-15T12:00:00Z",
        "duration_ms": 0,
        "response_status": 0,
        "response_body": "string",
        "error": "invalid_url"
      },
      "attempts": [
        {
          "number": 0,
          "manual": true,
          "started_at": "2026-01-15T12:00:00Z",
          "duration_ms": 0,
          "response_status": 0,
          "response_body": "string",
          "error": "invalid_url"
        }
      ],
      "created_at": "2026-01-15T12:00:00Z",
      "updated_at": "2026-01-15T12:00:00Z"
    }
  ],
  "deleted": [
    {
      "id": 0,
      "deleted_at": "2026-01-15T12:00:00Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true,
  "sync_cursor": "string"
}

Доставка вебхука со всеми попытками и ответами получателя

get/webhook-deliveries/{delivery}

Scope: webhooks:read

Параметры

Путь

  • deliveryintegerобязательно

    ID доставки вебхука.

Ответы

200Успешно

application/json

Возвращает WebhookDelivery

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

404Объекта нет или он недоступен приложению

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl "https://api.saleya.app/v1/webhook-deliveries/{delivery}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "id": 0,
  "endpoint_id": 0,
  "event_id": 0,
  "event_type": "string",
  "status": "pending",
  "attempt_count": 0,
  "next_attempt_at": "2026-01-15T12:00:00Z",
  "last_attempt": {
    "number": 0,
    "manual": true,
    "started_at": "2026-01-15T12:00:00Z",
    "duration_ms": 0,
    "response_status": 0,
    "response_body": "string",
    "error": "invalid_url"
  },
  "attempts": [
    {
      "number": 0,
      "manual": true,
      "started_at": "2026-01-15T12:00:00Z",
      "duration_ms": 0,
      "response_status": 0,
      "response_body": "string",
      "error": "invalid_url"
    }
  ],
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Отправить на адрес тестовое событие ping — одна попытка, подписанная текущим секретом

post/webhook-endpoints/{endpoint}/test

Scope: webhooks:write

Параметры

Путь

  • endpointintegerобязательно

    ID адреса вебхука.

Заголовок

  • Idempotency-Keystring

    Уникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324

Ответы

202Принято: исход — по адресу из Location

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true
  • Locationstring (uri)обязательно

    Адрес созданной записи, а у принятого к исполнению (202) — адрес, где следить за исходом.

application/json

Возвращает WebhookDelivery

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

404Объекта нет или он недоступен приложению

application/problem+json

Возвращает Problem

409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает ConflictProblem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl -X POST "https://api.saleya.app/v1/webhook-endpoints/{endpoint}/test" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 202
{
  "id": 0,
  "endpoint_id": 0,
  "event_id": 0,
  "event_type": "string",
  "status": "pending",
  "attempt_count": 0,
  "next_attempt_at": "2026-01-15T12:00:00Z",
  "last_attempt": {
    "number": 0,
    "manual": true,
    "started_at": "2026-01-15T12:00:00Z",
    "duration_ms": 0,
    "response_status": 0,
    "response_body": "string",
    "error": "invalid_url"
  },
  "attempts": [
    {
      "number": 0,
      "manual": true,
      "started_at": "2026-01-15T12:00:00Z",
      "duration_ms": 0,
      "response_status": 0,
      "response_body": "string",
      "error": "invalid_url"
    }
  ],
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Повторить доставку сейчас — тем же телом и с тем же webhook-id

post/webhook-deliveries/{delivery}/retry

Scope: webhooks:write

Параметры

Путь

  • deliveryintegerобязательно

    ID доставки вебхука.

Заголовок

  • Idempotency-Keystring

    Уникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324

Ответы

202Принято: исход — по адресу из Location

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true
  • Locationstring (uri)обязательно

    Адрес созданной записи, а у принятого к исполнению (202) — адрес, где следить за исходом.

application/json

Возвращает WebhookDelivery

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

404Объекта нет или он недоступен приложению

application/problem+json

Возвращает Problem

409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает ConflictProblem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl -X POST "https://api.saleya.app/v1/webhook-deliveries/{delivery}/retry" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 202
{
  "id": 0,
  "endpoint_id": 0,
  "event_id": 0,
  "event_type": "string",
  "status": "pending",
  "attempt_count": 0,
  "next_attempt_at": "2026-01-15T12:00:00Z",
  "last_attempt": {
    "number": 0,
    "manual": true,
    "started_at": "2026-01-15T12:00:00Z",
    "duration_ms": 0,
    "response_status": 0,
    "response_body": "string",
    "error": "invalid_url"
  },
  "attempts": [
    {
      "number": 0,
      "manual": true,
      "started_at": "2026-01-15T12:00:00Z",
      "duration_ms": 0,
      "response_status": 0,
      "response_body": "string",
      "error": "invalid_url"
    }
  ],
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}