Wprowadzenie

Mechanizm typu Webhooks jest prostym sposobem na otrzymywanie powiadomień w czasie rzeczywistym. Webhook jest mechanizmem podobny do API, ale komunikacja odbywa się w odwrotną stronę, czyli Ty definiujesz bramkę URL (callback URL) pod którą będziesz otrzymywać powiadomienia o różnych zdarzeniach w systemie. Każde zdarzenie będzie żądaniem HTTP POSTwysłanym pod wskazany przez Ciebie adres URL. W praktyce musisz napisać skrypt, który będzie w stanie obsłużyć żądania HTTP POST wysyłane od systemu FreshMail.

W tym momencie posiadamy jedną wersję mechanizmu Webhooks, który będzie cię powiadamiał za pomocą żądań HTTP POST o zdarzeniach, które miały miejsce w obrębie wysłanych przez Ciebie kampani mailingowych (np. otwarcie, kliknięcie).

Dla developerów

Działanie mechanizmu Webhooks wymaga zaimplementowania skryptu, który będzie w stanie odebrać dane oraz potwierdzić ich odbiór.

Wymagania

Pamiętaj, że skrypty, które stworzysz muszą być na tyle zoptymalizowane by mogły obsłużyć dużą liczbę żądań. Każde żądanie może zawierać nawet do 1000 zdarzeń i musi być obsłużone maksymalnie w przeciągu 5 sekund. Jeśli nie potrafisz obsłużyć naszych żądań odpowiednio szybko zalecamy odkładanie ich w jakichś mechanizmach po swojej stronie, a nam odpowiadać, że udało sie je przyjąć. Jeśli nie uda Ci się obsłużyc żądania w mniej niż 5 sekund po naszej stronie traktowane jest to jako błędna odpowiedź i dokładnie te same zdarzenia zostaną do Ciebie wysłane jeszcze raz w przyszłości.

Debugging

Mechanizmy typu Webhooks są trudne do debuggowania. Dlatego też, w interfejsie FreshMail'a jest sekcja w której mozna sprawdząć ostatnie błędy z komunikacji pomiędzy FreshMailem a Twoją bramką URL.