Список вебхуков
GET/v1/webhooks
Параметры
| Поле | Тип | Обязательно |
|---|---|---|
cursorзапрос | string | нет |
limitзапрос | integer | нет |
Ответы
200WebhookList400401403404409412413415422428429503
Справочник API
Вебхуки
Адреса доставки событий, секреты подписи и история доставок.
Создать вебхук
POST/v1/webhooks
Тело запросаWebhookCreate
| Поле | Тип | Обязательно |
|---|---|---|
url | string (uri) | да |
event_types | array of string | да |
description | string | нет |
Ответы
201Webhook400401403404409412413415422428429503
Изменить вебхук
PATCH/v1/webhooks/{webhook_id}
Параметры
| Поле | Тип | Обязательно |
|---|---|---|
webhook_idпуть | string (uuid) | да |
Тело запросаWebhookUpdate
| Поле | Тип | Обязательно |
|---|---|---|
url | string (uri) | нет |
event_types | array of string | нет |
status | enum: disabled, active | нет |
Ответы
200Webhook400401403404409412413415422428429503
Удалить вебхук
DELETE/v1/webhooks/{webhook_id}
Параметры
| Поле | Тип | Обязательно |
|---|---|---|
webhook_idпуть | string (uuid) | да |
Ответы
204400401403404409412413415422428429503
Тестовое событие
POST/v1/webhooks/{webhook_id}/test
Параметры
| Поле | Тип | Обязательно |
|---|---|---|
webhook_idпуть | string (uuid) | да |
Ответы
202Delivery400401403404409412413415422428429503
Сменить секрет подписи
POST/v1/webhooks/{webhook_id}/rotate-secret
Параметры
| Поле | Тип | Обязательно |
|---|---|---|
webhook_idпуть | string (uuid) | да |
Тело запросаReasonAction
| Поле | Тип | Обязательно |
|---|---|---|
reason_code | string | да |
note | string | нет |
Ответы
200SecretIssued400401403404409412413415422428429503
Доставки вебхука
GET/v1/webhooks/{webhook_id}/deliveries
Параметры
| Поле | Тип | Обязательно |
|---|---|---|
webhook_idпуть | string (uuid) | да |
cursorзапрос | string | нет |
limitзапрос | integer | нет |
Ответы
200DeliveryList400401403404409412413415422428429503