Sign in
Webhooks

Создание webhook

Запрос позволяет подписаться на уведомления о событиях: https://yookassa.ru/developers/using-api/webhooks#events (например, переход платежа в статус succeeded). C помощью webhook можно подписаться только на события платежей и возвратов. Если вы хотите получать уведомления о нескольких событиях, вам нужно для каждого из них создать свой webhook. Для каждого OAuth-токена нужно создавать свой набор webhook.

post/webhooks

Headers

Idempotence-Keystring required

Request body

event'payment.waiting_for_capture' | 'payment.succeeded' | 'payment.canceled' | 'refund.succeeded' required

Событие: https://yookassa.ru/developers/using-api/webhooks#events, которое вы хотите отслеживать.

urlstring required

URL, на который ЮKassa будет отправлять уведомления.

Example request

{
  "event": "payment.succeeded",
  "url": "https://www.example.com/notification_url"
}

Response

Запрос успешно обработан

idstring required

Идентификатор webhook.

event'payment.waiting_for_capture' | 'payment.succeeded' | 'payment.canceled' | 'refund.succeeded' required

Событие: https://yookassa.ru/developers/using-api/webhooks#events, о котором уведомляет ЮKassa.

urlstring required

URL, на который ЮKassa отправляет уведомления.

Example response

{
  "id": "wh-e44e8088-bd73-43b1-959a-954f3a7d0c54",
  "event": "payment.succeeded",
  "url": "https://www.example.com/notification_url"
}

Changes