Як отримувати вебхуки
У Zenedu два способи надіслати вебхук. Обидва приходять в одному форматі, підписуються однаково і повторюються за одними правилами.Швидкий старт
1
Створіть обробник
Додайте на свій сервер публічну HTTPS-адресу, яка приймає
POST-запити з JSON-тілом і відповідає статусом 2xx.2
Додайте вебхук
Відкрийте Налаштування → Проєкт → API та вебхуки, у блоці Вебхуки натисніть Додати, вкажіть адресу й оберіть події. Те саме робить Створити вебхук.
3
Надішліть тест
Натисніть Надіслати тест або викличте Надіслати тестовий вебхук. На адресу прийде подія
webhook.test.4
Перевіряйте підпис
Перш ніж довіряти запиту, перевірте підпис у заголовку
Signature.Формат запиту
Кожен вебхук — цеPOST-запит із тілом у JSON. Тіло завжди однієї форми: службові поля та об’єкт події в data.
Об’єкти в
data збігаються з об’єктами API: підписник — як в Отримати підписника, замовлення — як в Отримати замовлення. Поля події, наприклад tag_id і tag_name, лежать поруч із полями підписника.
Заголовки
Підпис
Zenedu підписує кожен вебхук. ЗаголовокSignature містить HMAC-SHA256 від сирого тіла запиту в шістнадцятковому вигляді, ключ — API-токен акаунта. Щоб перевірити запит, обчисліть HMAC від тіла в тому вигляді, в якому воно прийшло, до розбору JSON, і порівняйте із заголовком:
Рекомендації
- Відповідайте швидко. Поверніть
2xxпротягом 3 секунд, а важку роботу — запис у CRM, листи, запити до API — виконуйте у фоновій черзі. Запит, на який немає відповіді за 3 секунди, вважається невдалим і буде надісланий повторно. - Прибирайте дублі. Одна подія може прийти більше ніж один раз. Зберігайте
_idоброблених доставок і пропускайте повтори. - Не покладайтеся на порядок. Кожен вебхук — окремий HTTP-запит, і через мережеві затримки або повторну спробу події, що сталися майже одночасно, можуть прийти в іншому порядку. Якщо порядок важливий, порівнюйте
timestamp. - Підписуйтеся лише на потрібні події. Зайві події навантажують ваш сервер і не дають користі.
Що далі
Доставка та повтори
Розклад повторних спроб і автовимкнення
Каталог подій
Усі події та їхні дані
Вебхуки в API
Керування підписками через API