Hopp til hovedinnhold
Webhooks-integrasjonen er for utviklere. Den sender en JSON-hendelse til en HTTPS-adresse du velger hver gang noe skjer i Foliant, slik at ditt eget system kan reagere, for eksempel ved å arkivere hver faktura-PDF eller hente en ferdig eksport. Webhooks er i beta. Hvis du ikke ser den under Innstillinger › Integrasjoner, er den ikke tilgjengelig for butikken din ennå. Kontakt kundestøtte for å spørre om tilgang.

Hendelser

Koble til webhooks

  1. Gå til Innstillinger › Integrasjoner i Foliant.
  2. Klikk på Koble til under Webhooks.
  3. Fyll ut innstillingene:
  4. Klikk på Koble til.
Du kan endre URL-en, hemmeligheten og hendelsene senere under Innstillinger på integrasjonens side.

Hva hver forespørsel inneholder

Foliant sender en POST-forespørsel med en JSON-brødtekst:

Data for document.generated

  • template: malens uuid og name.
  • document_type: invoice, credit_note, quote, eller tom for andre dokumenter.
  • order: ordrens id, name og type (ordrer eller ordreutkast).
  • refund_id og fulfillment_id, når dokumentet gjelder en refusjon eller en forsendelse.
  • document_number og issued_at, for nummererte dokumenter.
  • source: hvordan det ble laget, for eksempel download, admin_download, export eller email.
  • export: eksportens ID, når det er en del av en eksport.
  • generated_at.

Data for export.completed

  • export: eksportens uuid, order_type, template_uuids, antall orders, orders_skipped (slettet etter at de ble valgt) og documents, requested_by (merchant eller customer) og completed_at.
  • download_url: en lenke for å laste ned eksporten, og download_url_expires_at, når lenken slutter å virke.
  • download_expires_at: når selve eksporten utløper.
Hendelser inneholder ID-er og antall, ikke kunders e-postadresser.

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.
Hver levering vises under Aktivitet på integrasjonens side, der du kan klikke på Prøv igjen for en mislykket levering. Se Integrasjonsaktivitet.

Relaterte artikler