Odbieranie webhooków po zakończeniu workflow
Powiadamianie Twoich systemów, gdy przetwarzanie workflow się kończy, nie powiedzie się lub zostanie zatrzymane, oraz weryfikacja podpisu wysyłek.
Webhooki powiadamiają Twoje systemy, gdy przetwarzanie workflow się kończy. Upsellr wysyła wtedy żądanie na wybrany przez Ciebie adres. Są dostępne w planie Enterprise.
Zdarzenia
| Zdarzenie | Kiedy jest emitowane |
|---|---|
| workflow.run.completed | Przetwarzanie kończy się sukcesem |
| workflow.run.failed | Przetwarzanie się nie powiodło |
| workflow.run.stopped | Użytkownik zatrzymuje przetwarzanie |
Każda wysyłka zawiera pełną reprezentację przetwarzania, w tym samym formacie co publiczne API. Karta Event catalogue opisuje ten format.
Dodawanie endpointu
- Otwórz menu konta, a następnie Manage i API & webhooks.
- Na karcie Endpoints kliknij Add endpoint.
- Podaj Name i Endpoint URL. Akceptowane są tylko publiczne adresy HTTPS: sieci prywatne i przekierowania są blokowane.
- Zaznacz Events to receive, a następnie zapisz.
- Skopiuj sekret podpisu. Wyświetla się tylko raz.
Endpoint można wstrzymać, a potem ponownie włączyć. Jeśli zgubisz sekret, kliknij Rotate secret i od razu zaktualizuj swój odbiornik.
Weryfikacja podpisu
Każda wysyłka zawiera dwa nagłówki: X-Upsellr-Timestamp, znacznik czasu wysyłki, oraz X-Upsellr-Signature w postaci v1=, po którym następuje skrót szesnastkowy zapisany małymi literami. Skrót to HMAC-SHA256, obliczony przy użyciu sekretu endpointu, ze znacznika czasu, kropki, a następnie surowej treści żądania.
Weryfikuj podpis na surowej treści, przed zdekodowaniem JSON. Porównuj podpisy w stałym czasie i odrzucaj zbyt stare znaczniki czasu.
Wysyłki i ponowne próby
- Zdarzenia są wysyłane w formacie JSON, żądaniem POST. Każda odpowiedź 2xx potwierdza odbiór.
- W razie niepowodzenia Upsellr ponawia próbę po 1 minucie, 5 minutach, 30 minutach, 4 godzinach i 24 godzinach.
- Zdarzenie może dotrzeć więcej niż raz, a kolejność nie jest gwarantowana: usuwaj duplikaty według identyfikatora zdarzenia.
Dziennik dostarczeń
Karta Event deliveries pokazuje wysyłki z ostatnich 7 dni wraz z ich statusem, próbami i treścią. W przypadku nieudanej wysyłki kliknij Replay failed delivery: to samo zdarzenie zostanie wysłane ponownie, z tym samym identyfikatorem.
Dobrze wiedzieć
- Tylko właściciele i administratorzy zarządzają endpointami i ponawiają wysyłki.
- Usunięcie endpointu anuluje jego oczekujące wysyłki. Istniejące dzienniki zostają zachowane.