Webhooks

Использование вебхуков для получения уведомлений о событиях, происходящими с картами Apple Wallet и Google Pay

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

Когда возникает событие, например, сохранение карты в 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 Pay создана
  • pass.aw.updated - Карта Apple Wallet изменена
  • pass.gp.updated - Карта Google Pay изменена
  • registration.aw.created - Карта Apple Wallet установлена на телефон
  • registration.gp.created - Карта Google Pay установлена на телефон
  • registration.aw.deleted - Карта Apple Wallet удалена с телефона или отключены уведомления
  • registration.gp.deleted - Карта Google Pay удалена с телефона