Hendelser
Koble til webhooks
- Gå til Innstillinger › Integrasjoner i Foliant.
- Klikk på Koble til under Webhooks.
-
Fyll ut innstillingene:
- Klikk på Koble til.
Hva hver forespørsel inneholder
Foliant sender enPOST-forespørsel med en JSON-brødtekst:
Data for document.generated
template: malensuuidogname.document_type:invoice,credit_note,quote, eller tom for andre dokumenter.order: ordrensid,nameogtype(ordrer eller ordreutkast).refund_idogfulfillment_id, når dokumentet gjelder en refusjon eller en forsendelse.document_numberogissued_at, for nummererte dokumenter.source: hvordan det ble laget, for eksempeldownload,admin_download,exportelleremail.export: eksportens ID, når det er en del av en eksport.generated_at.
Data for export.completed
export: eksportensuuid,order_type,template_uuids, antallorders,orders_skipped(slettet etter at de ble valgt) ogdocuments,requested_by(merchantellercustomer) ogcompleted_at.download_url: en lenke for å laste ned eksporten, ogdownload_url_expires_at, når lenken slutter å virke.download_expires_at: når selve eksporten utløper.
Overskrifter
Sjekk signaturen
Signaturen er en heksadesimal HMAC-SHA256 av tidsstempelet, et punktum og den rå brødteksten i forespørselen (<timestamp>.<body>), med signeringshemmeligheten din som nøkkel. Beregn den på din side, og sammenlign den med verdien etter sha256= i X-Foliant-Signature. Bruk den rå brødteksten nøyaktig slik du mottok den.
Svar og nye forsøk
- Ethvert 2xx-svar regnes som levert.
- Hvis endepunktet ditt returnerer en 5xx-feil, 408 eller 429, eller ikke svarer innen 10 sekunder, prøver Foliant igjen senere og venter lenger hver gang, opptil 5 forsøk.
- Andre 4xx-svar er endelige: Foliant prøver ikke på nytt.
- Hver hendelse leveres én gang per dokument eller eksport. Nye forsøk sender den aldri to ganger etter en vellykket levering.