Webhooks

Використання веб-хуків для отримання повідомлень про події, що відбуваються з картками Apple Wallet та Google Wallet

Вебхуки служать для повідомлення вашого сервісу про зміни, що відбулися з картками Apple Wallet та Google Wallet

Коли виникає подія, наприклад, збереження картки в Apple Wallet, створюється об'єкт, який надсилається HTTP POST запитом за вказаною вами адресою. Цей об'єкт містить релевантну інформацію, включаючи тип події та інформацію, що стосується цієї події.

Верифікація вебхука

Перед використанням вебхука, нам спочатку потрібно перевірити URL-адресу, яка прийматиме вебхуки. Для цього ми надсилаємо подію webhook.verify з токеном на вашу URL.

Для успішної перевірки Вам необхідно повернути отриманий токен у відповідь разом із статусом 200.

Отримання вебхука

Дані вебхуки відправляються у форматі JSON у тілі POST запиту c HTTP заголовком x-loyal: event.

Подія має цифровий підпис, щоб ви могли переконатися, що вона дійсно прийшла з нашого сервера

Перетворене в рядок тіло запиту підписано HMAC-SHA1 за допомогою токена, який ви отримаєте під час активації вебхуків.
Підпис додається як заголовок HTTP з ім'ям x-loyal-signature.

Типи подій:

webhook.verify - Перевірка вебхука
pass.aw.created - Карта Apple Wallet створена
pass.gp.created - Карта Google Wallet створена
pass.aw.updated - Карта Apple Wallet змінена
pass.gp.updated - Карта Google Wallet змінена
registration.aw.created - Карта Apple Wallet встановлена на телефон
registration.gp.created - Карта Google Wallet встановлена на телефон
registration.aw.deleted - Карта Apple Wallet видалена з телефону або відключені повідомлення
registration.gp.deleted - Карта Google Wallet видалена з телефону