Mechanizm tworzenia webhooków

Mechanizm tworzenia webhooków

Webhooks (w odróżnieniu od API) to prosty i skuteczny mechanizm komunikacji między wFirma.pl, a systemem zewnętrznym (np. sklepem internetowym). Pozwala na wysyłanie żądań POST (requestów) na dowolny adres URL, bezpośrednio po wykonaniu zdefiniowanych akcji, bez potrzeby cyklicznego odpytywania aplikacji przez API. Dzięki zastosowaniu webhooków znacznie zmniejsza się obciążenie serwera aplikacji.

Dodawanie webhooków

Webhooki można dodać w zakładce: USTAWIENIA w sekcji INNE » WEBHOOKS poprzez akcję Dodaj.

Mechanizm tworzenia webhooków - widok z ustawień

W otwartym oknie Inne - Webhooks można dodać za pomocą przycisku Dodaj.

Mechanizm tworzenia webhooków - tworzenie

W oknie Dodawanie webhooka dostępne są pola:

Post URL - pozwalający na wysyłanie informacji pod ustalony przez administratora adres url

Zdarzenie - lista konkretnych zdarzeń odnośnie których informacja jest przekazywana

Typ danych - do wyboru JSON lub XML

Mechanizm tworzenia webhooków - tworzenie

Obsługiwane zdarzenia i przykładowy skrypt

Lista obsługiwanych zdarzeń:

  • Faktury (Dodanie, Modyfikacja, Usunięcie),

  • Kontrahenci (Dodanie),

  • Płatności (Dodanie),

  • Produkty (Dodanie, Zmiana ilości na magazynie),

  • Ustawienia (Zweryfikowanie firmy),

  • Zmiana pakietu,

  • Zmiana okresu pakietu;

Po 10 nieudanych próbach wysyłki, webhook jest automatycznie wyłączany. Trzeba go ponownie włączyć ręcznie.

Po kliknięciu na ikonę przy wysłanym żądaniu, pokazane zostaną ewentualne logi błędów.

Mechanizm tworzenia webhooków - lista logów

Przykładowy skrypt odbierający webhooka:

Mechanizm tworzenia webhooków