Webhooks

Wykorzystanie webhooków do otrzymywania powiadomień o zdarzeniach związanych z kartami Apple Wallet i Google Wallet

Webhooki służą do powiadamiania twojego serwisu o zmianach, które zachodzą na kartach Apple Wallet i Google Wallet.

Gdy występuje zdarzenie, na przykład zapisanie karty w Apple Wallet, tworzony jest obiekt, który jest wysyłany jako żądanie HTTP POST na adres, który podajesz. Ten obiekt zawiera odpowiednie informacje, w tym typ zdarzenia i informacje związane z tym zdarzeniem.

Weryfikacja webhooka

Przed użyciem webhooka, musimy najpierw zweryfikować adres URL, który będzie przyjmował webhooki. Aby to zrobić, wysyłamy zdarzenie webhook.verify z tokenem na Twoje URL.

Aby weryfikacja przebiegła pomyślnie, musisz zwrócić otrzymany token w odpowiedzi razem ze statusem 200.

Odbieranie webhooka

Dane webhooka są przesyłane w formacie JSON w treści żądania POST z nagłówkiem HTTP x-loyal: event.

Zdarzenie ma cyfrowy podpis, aby upewnić się, że rzeczywiście pochodzi z naszego serwera.

Treść żądania jest przekształcona na ciąg i podpisana za pomocą HMAC-SHA1 przy użyciu tokenu, który otrzymasz podczas aktywacji webhooków.
Podpis jest dodawany jako nagłówek HTTP o nazwie x-loyal-signature.

Typy zdarzeń:

webhook.verify - Weryfikacja webhooka
pass.aw.created - Utworzono kartę Apple Wallet
pass.gp.created - Utworzono kartę Google Wallet
pass.aw.updated - Zaktualizowano kartę Apple Wallet
pass.gp.updated - Zaktualizowano kartę Google Wallet
registration.aw.created - Karta Apple Wallet została zainstalowana na telefonie
registration.gp.created - Karta Google Wallet została zainstalowana na telefonie
registration.aw.deleted - Karta Apple Wallet została usunięta z telefonu lub wyłączone powiadomienia
registration.gp.deleted - Karta Google Wallet została usunięta z telefonu