Перейти до основного вмісту
Вебхуки надсилають HTTP-запит POST на ваш сервер, коли у вашому магазині щось відбувається, тож вам не потрібно регулярно опитувати API. Створюйте ендпоінти в розділі Developers › Webhooks або через POST /webhooks.

Події

GET /events/types повертає той самий список.

Корисне навантаження

Суми у вебхуках подано в основних одиницях (34.99), на відміну від API, яке використовує дрібні одиниці (3499).

Перевірте підпис

Кожен запит містить такі заголовки: Підпис обчислюється як HMAC-SHA256(secret, "<t>.<raw body>") у шістнадцятковому форматі. Секрет (whsec_...) показується під час створення ендпоінта. Обчислюйте підпис від сирого тіла запиту, до розбору JSON, і відхиляйте застарілі позначки часу.

Відповідь і повторні спроби

  • Відповідайте будь-яким статусом 2xx протягом 10 секунд. Повільну роботу виконуйте вже після відповіді.
  • Невдалі доставки повторюються через 1 хвилину, 5 хвилин, 30 хвилин, 2 години, 6 годин і 12 годин (7 спроб приблизно за 21 годину).
  • Ендпоінт вимикається після 40 невдач поспіль без жодного успіху протягом 3 днів. Увімкніть його знову в панелі керування або через PATCH /webhooks/{id} з enabled: true.
  • Та сама подія може надійти більше ніж один раз. Використовуйте PapelShip-Event-Id, щоб обробити її лише один раз.

Керування ендпоінтами через API

Відповідь містить secret для підпису. Він показується лише один раз; збережіть його в середовищі вашого сервера. Заміна секрету виконується лише в панелі керування.