Co robią webhooki
Webhook to subskrypcja konkretnego zdarzenia sklepu. Gdy to zdarzenie wystąpi, Storeep natychmiast wysyła dane zdarzenia na podany przez Ciebie adres URL (typ API) lub adres e-mail (typ E-mail). Webhooki są powszechnie używane do integracji śledzenia zamówień, synchronizacji CRM, konwersji platform reklamowych i automatycznych powiadomień.
Aby zarządzać webhookami, przejdź do Ustawienia → Webhooki.
Limity webhooków
- Maksymalnie 20 webhooków na sklep. Próba dodania 21. zwraca błąd.
- Webhooki są wyświetlane od najnowszego, paginowane po 40 na stronę.
Tworzenie webhooka
Kliknij Dodaj nowy webhook.
Przełącznik aktywacji
Gdy zaznaczony (domyślnie), webhook jest aktywny od momentu zapisania. Zdarzenia są wysyłane natychmiast. Odznacz, aby zapisać webhook w stanie wyłączonym bez otrzymywania zdarzeń. Możesz włączać lub wyłączać webhook w dowolnym momencie przez edycję.
Nazwa
- Wymagane.
- Maksymalnie 50 znaków.
- Opisowa etykieta wyświetlana na liście webhooków. Przykład: Facebook CAPI, zamówienie utworzone.
Typ
Kontroluje, jak ładunek zdarzenia jest dostarczany. Dwie opcje:
- API: Storeep wysyła żądanie HTTP POST z danymi zdarzenia na podany adres URL.
- E-mail: Storeep wysyła e-mail z danymi zdarzenia na podany adres.
Zdarzenie
Zdarzenie sklepu wyzwalające ten webhook. Dostępne są trzy zdarzenia:
- Sesja utworzona: uruchamia się, gdy w sklepie zostaje utworzona nowa sesja odwiedzającego.
- Zamówienie utworzone: uruchamia się, gdy zostaje złożone nowe zamówienie.
- Zamówienie zaktualizowane: uruchamia się, gdy status lub dane istniejącego zamówienia ulegają zmianie.
Format
Format danych ładunku zdarzenia. Aktualnie jedna opcja:
- Json: ładunek jest wysyłany jako dokument JSON.
URL (tylko typ API)
- Wymagane, gdy typ to API.
- Maksymalnie 500 znaków. Wyższy limit pomieści adresy URL zawierające wiele segmentów zastępczych.
- Wpisz adres URL punktu końcowego bez prefiksu
https://. Jest dodawany automatycznie. Przykład:api.example.com/events/order. - Dynamiczne symbole zastępcze URL: dowolne pole z ładunku zdarzenia można wstrzyknąć do adresu URL za pomocą składni podwójnych nawiasów klamrowych:
{{nazwa_pola}}. Na przykład:https://example.com/postback?cid={{fbclid}}&payout={{order_total}}
Pozwala to wysyłać dane konwersji do platform reklamowych bezpośrednio z adresu URL webhooka bez osobnego serwera proxy. - Jeśli struktura URL jest nieprawidłowa po rozwiązaniu symboli zastępczych, otrzymasz błąd walidacji.
Adres e-mail (tylko typ e-mail)
- Wymagane, gdy typ to E-mail.
- Musi być prawidłowym adresem e-mail, maksymalnie 127 znaków.
Edytowanie webhooka
Kliknij dowolny wiersz webhooka, aby otworzyć edytor. Wszystkie pola są edytowalne. Pole URL wypełnia się wstępnie tylko gdy bieżący typ to API; pole e-mail wypełnia się wstępnie tylko gdy bieżący typ to E-mail. Zmiana typu czyści drugie pole.
Włączanie i wyłączanie webhooków
Pole wyboru Aktywuj na górze edytora kontroluje, czy webhook uruchamia się. Status na liście pokazuje Aktywowany lub Dezaktywowany. Wyłączony webhook nie rejestruje żadnych dostaw, ale nie jest usuwany, więc możesz go ponownie włączyć bez rekonfiguracji.
Kolumny listy webhooków
- Nazwa: etykieta webhooka z datą utworzenia.
- URL / E-mail: adres docelowy.
- Typ: API lub E-mail.
- Zdarzenie: nazwa zdarzenia (Sesja utworzona, Zamówienie utworzone lub Zamówienie zaktualizowane).
- Format: Json.
- Status: Aktywowany lub Dezaktywowany.
Usuwanie webhooka
Wybierz jeden lub więcej webhooków i kliknij Usuń webhooki. Jest to nieodwracalne i zatrzymuje wszystkie przyszłe dostawy dla tej subskrypcji.
Wskazówki i pułapki
- Możesz tworzyć wiele webhooków dla tego samego zdarzenia, na przykład wysyłać Zamówienie utworzone zarówno do CRM, jak i platformy reklamowej jako oddzielne wpisy webhooków.
- Jeśli punkt końcowy wymaga uwierzytelnienia, dodaj dane uwierzytelniające do ciągu zapytania URL używając symbolu zastępczego
{{placeholder}}z danych zdarzenia lub skonfiguruj serwer proxy obsługujący uwierzytelnianie przed przekazaniem do rzeczywistego punktu końcowego. - Zdarzenie Sesja utworzona uruchamia się dla każdej unikalnej sesji odwiedzającego, co może być dużym wolumenem w popularnych sklepach. Subskrybuj je tylko wtedy, gdy punkt końcowy może obsłużyć taką przepustowość.