Události
Propojení webhooků
- Ve Foliantu přejděte do Nastavení › Integrace.
- U položky Webhooky klikněte na Propojit.
-
Vyplňte nastavení:
- Klikněte na Propojit.
Co obsahuje každý požadavek
Foliant odešle požadavekPOST s tělem JSON:
Data document.generated
template:uuidanamešablony.document_type:invoice,credit_note,quote, nebo prázdné u jiných dokumentů.order: jejíid,nameatype(objednávky nebo koncepty objednávek).refund_idafulfillment_id, pokud je dokument k refundaci nebo zásilce.document_numberaissued_atu číslovaných dokumentů.source: jak dokument vznikl, napříkladdownload,admin_download,exportneboemail.export: ID exportu, pokud je dokument součástí exportu.generated_at.
Data export.completed
export: jehouuid,order_type,template_uuids, početorders,orders_skipped(smazané po výběru) adocuments,requested_by(merchantnebocustomer) acompleted_at.download_url: odkaz ke stažení exportu adownload_url_expires_at, kdy tento odkaz přestane fungovat.download_expires_at: kdy vyprší platnost samotného exportu.
Hlavičky
Ověření podpisu
Podpis je hexadecimální HMAC-SHA256 z časového razítka, tečky a nezpracovaného těla požadavku (<timestamp>.<body>), s vaším podpisovým klíčem jako klíčem. Vypočítejte ho na své straně a porovnejte s hodnotou za sha256= v X-Foliant-Signature. Použijte nezpracované tělo přesně tak, jak bylo přijato.
Odpovědi a opakované pokusy
- Jakákoli odpověď 2xx se počítá jako doručení.
- Pokud váš endpoint vrátí chybu 5xx, 408 nebo 429, nebo neodpoví do 10 sekund, Foliant to zkusí později znovu, pokaždé s delším odstupem, nejvýše 5 pokusů.
- Ostatní odpovědi 4xx jsou konečné: Foliant je neopakuje.
- Každá událost se doručí jednou na dokument nebo export. Opakované pokusy ji po úspěchu nikdy neodešlou dvakrát.