webhooks

Зареєструвати вебхук

Доставка — POST з тілом {delivery_id, event, attempt, sequence, occurred_at, data} і заголовком X-Signature вигляду "sha256=<HMAC-SHA256 тіла у hex>", порахованим на секреті цієї точки доставки.

Гарантія — «щонайменше один раз»: приймач має відкидати повтори за delivery_id.

Події одного реєстратора надсилаються по одній і по порядку. Подія, яку приймач не прийняв, не затримує наступні: після повтору чи replay вона може прийти пізніше за них. Упорядковуйте події реєстратора за sequence — номером події в межах реєстратора, що зростає (пропуски можливі). Актуальний стан каси — GET /v1/cash-registers/{id}.

post/v1/webhooks

Request

  • Base URL: https://prro.cloud (the document declares no server; this is the origin it was published from)
  • URL: https://prro.cloud/v1/webhooks
  • Auth: HTTP bearer

Request body

urlstring required

Абсолютний http(s)-URL приймача.

eventsWebhookEvent[]

Події, на які підписані; порожній список або відсутнє поле означає всі події.

secretstring

Секрет HMAC; якщо не вказати, згенерує сервер.

Response

Створено; секрет повертається рівно один раз.

idstring uuid required

Ідентифікатор вебхука.

urlstring required

Абсолютний http(s)-URL приймача.

eventsWebhookEvent[] required

Порожній список означає підписку на всі події.

activeboolean required

Доставка ввімкнена; false призупиняє її, не втрачаючи черги.

created_atstring date-time required

Коли вебхук створено.

updated_atstring date-time required

Коли його востаннє змінювали.

secretstring required

Отримати повторно неможливо.

Changes

No recorded changes to this operation across all 1 revision of this API.