Обновление вебхука
Обновляет информацию о вебхуке.
Request
PATCH
https://api.kit.yandex.net/v1/webhooks/{webhook_id}
Body
application/json
{
"url": "https://example.com/webhook",
"events": [
"ORDER_STATUS_CHANGED"
],
"deactivate": true
}
|
Name |
Description |
|
deactivate |
Type: boolean Деактивировать вебхук, переведя его в статус |
|
events |
Type: WebhookEventTypes[] Список типов событий, на которые подписывается вебхук. Example |
|
url |
Type: string URL вебхука. Поддерживается только HTTPS протокол. Example: |
WebhookEventTypes
Тип события:
ORDER_STATUS_CHANGED— изменился статус заказа.ORDER_PAYMENT_STATUS_CHANGED— изменился статус оплаты заказа.ORDER_DELIVERY_STATUS_CHANGED— изменился статус доставки заказа.
Type: string
Enum: ORDER_STATUS_CHANGED, ORDER_PAYMENT_STATUS_CHANGED, ORDER_DELIVERY_STATUS_CHANGED
Responses
200 OK
Вебхук обновлен.
Body
application/json
{
"id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
"url": "https://example.com/webhook",
"events": [
"ORDER_STATUS_CHANGED"
],
"status": "ACTIVE"
}
|
Name |
Description |
|
events |
Type: WebhookEventTypes[] Список типов событий, на которые подписан вебхук. Example |
|
id |
Type: WebhookID ID вебхука. Example: |
|
status |
Type: WebhookStatus Статус вебхука:
Enum: |
|
url |
Type: string URL вебхука. Example: |
WebhookID
ID вебхука.
Type: string<uuid>
Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9
WebhookStatus
Статус вебхука:
ACTIVE— активный.INACTIVE— неактивный.
Type: string
Enum: ACTIVE, INACTIVE
400 Bad Request
Некорректный запрос.
Body
application/json
{
"code": "VALIDATION_ERROR",
"message": "Invalid input",
"trace_id": "00000000000000000000000000000000"
}
|
Name |
Description |
|
code |
Type: string Example: |
|
message |
Type: string Example: |
|
trace_id |
Type: string Уникальный идентификатор запроса для отладки. Example: |
401 Unauthorized
Не авторизован.
Body
application/json
{
"code": "VALIDATION_ERROR",
"message": "Invalid input",
"trace_id": "00000000000000000000000000000000"
}
|
Name |
Description |
|
code |
Type: string Example: |
|
message |
Type: string Example: |
|
trace_id |
Type: string Уникальный идентификатор запроса для отладки. Example: |
404 Not Found
Ресурс не найден.
Body
application/json
{
"code": "VALIDATION_ERROR",
"message": "Invalid input",
"trace_id": "00000000000000000000000000000000"
}
|
Name |
Description |
|
code |
Type: string Example: |
|
message |
Type: string Example: |
|
trace_id |
Type: string Уникальный идентификатор запроса для отладки. Example: |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
application/json
{
"code": "VALIDATION_ERROR",
"message": "Invalid input",
"trace_id": "00000000000000000000000000000000"
}
|
Name |
Description |
|
code |
Type: string Example: |
|
message |
Type: string Example: |
|
trace_id |
Type: string Уникальный идентификатор запроса для отладки. Example: |