Доставки вебхуков
Что ушло на адрес, что ждёт повтора и что не доставлено, с ответами получателя; доставку можно повторить.
Доставки вебхуков
Объекты
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
Записи страницы.
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"{
"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"{
"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-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же 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
Отказы метода
- 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X POST "https://api.saleya.app/v1/webhook-endpoints/{endpoint}/test" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"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-Replayedstringtrue, когда это сохранённый ответ более раннего запроса с тем же 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
Отказы метода
- 409
idempotency_key_in_useЗапрос с этим ключом ещё исполняется - 422
idempotency_key_reusedКлюч идемпотентности уже использован - 422
invalid_idempotency_keyКлюч идемпотентности неверен
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl -X POST "https://api.saleya.app/v1/webhook-deliveries/{delivery}/retry" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"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"
}