Zdarzenia
Połącz webhooki
- W Foliant przejdź do Ustawienia › Integracje.
- Przy Webhooki kliknij Połącz.
-
Wypełnij ustawienia:
- Kliknij Połącz.
Co zawiera każde żądanie
Foliant wysyła żądaniePOST z treścią JSON:
Dane document.generated
template:uuidinameszablonu.document_type:invoice,credit_note,quotelub puste dla innych dokumentów.order: jegoid,nameitype(zamówienia lub wersje robocze zamówień).refund_idifulfillment_id, gdy dokument dotyczy zwrotu pieniędzy lub przesyłki.document_numberiissued_at, dla dokumentów numerowanych.source: sposób utworzenia, np.download,admin_download,exportlubemail.export: ID eksportu, gdy dokument jest częścią eksportu.generated_at.
Dane export.completed
export: jegouuid,order_type,template_uuids, liczbaorders,orders_skipped(usunięte po wybraniu) idocuments,requested_by(merchantlubcustomer) orazcompleted_at.download_url: link do pobrania eksportu, orazdownload_url_expires_at, czyli moment, w którym link przestaje działać.download_expires_at: kiedy wygasa sam eksport.
Nagłówki
Sprawdź podpis
Podpis to szesnastkowy HMAC-SHA256 ze znacznika czasu, kropki i surowej treści żądania (<timestamp>.<body>), z Twoim sekretem podpisu jako kluczem. Oblicz go po swojej stronie i porównaj z wartością po sha256= w X-Foliant-Signature. Użyj surowej treści dokładnie w takiej postaci, w jakiej ją otrzymasz.
Odpowiedzi i ponowienia
- Każda odpowiedź 2xx oznacza dostarczenie.
- Jeśli Twój endpoint zwróci błąd 5xx, 408 lub 429 albo nie odpowie w ciągu 10 sekund, Foliant spróbuje ponownie później, za każdym razem czekając dłużej, maksymalnie 5 razy.
- Inne odpowiedzi 4xx są ostateczne: Foliant ich nie ponawia.
- Każde zdarzenie jest dostarczane raz na dokument lub eksport. Po udanym dostarczeniu ponowienia nigdy nie wysyłają go drugi raz.