Spring til hovedindhold
Webhooks-integrationen er til udviklere. Den sender en JSON-hændelse til en HTTPS-adresse, du vælger, hver gang der sker noget i Foliant. Så kan dit eget system reagere, for eksempel ved at arkivere hver faktura-PDF eller hente en færdig eksport. Webhooks er i beta. Hvis du ikke kan se den under Indstillinger › Integrationer, er den ikke tilgængelig for din butik endnu. Kontakt support for at spørge om adgang.

Hændelser

Forbind webhooks

  1. Gå til Indstillinger › Integrationer i Foliant.
  2. Klik på Forbind ved Webhooks.
  3. Udfyld indstillingerne:
  4. Klik på Forbind.
Du kan ændre URL, nøgle og hændelser senere under Indstillinger på integrationens side.

Hvad hver anmodning indeholder

Foliant sender en POST-anmodning med en JSON-body:

Data for document.generated

  • template: skabelonens uuid og name.
  • document_type: invoice, credit_note, quote eller tom for andre dokumenter.
  • order: dens id, name og type (ordrer eller ordrekladder).
  • refund_id og fulfillment_id, når dokumentet gælder en refundering eller en forsendelse.
  • document_number og issued_at for nummererede dokumenter.
  • source: hvordan det blev lavet, f.eks. download, admin_download, export eller email.
  • export: eksportens ID, når det er en del af en eksport.
  • generated_at.

Data for export.completed

  • export: dens uuid, order_type, template_uuids, antal orders, orders_skipped (slettet efter de blev valgt) og documents, requested_by (merchant eller customer) og completed_at.
  • download_url: et link til at downloade eksporten, og download_url_expires_at, hvornår linket holder op med at virke.
  • download_expires_at: hvornår selve eksporten udløber.
Hændelser indeholder ID’er og antal, ikke kunders e-mailadresser.

Headers

Tjek signaturen

Signaturen er en hex-HMAC-SHA256 af tidsstemplet, et punktum og den rå anmodnings-body (<timestamp>.<body>), med din signeringsnøgle som nøgle. Beregn den på din side, og sammenlign den med værdien efter sha256= i X-Foliant-Signature. Brug den rå body præcis, som du modtog den.

Svar og nye forsøg

  • Ethvert 2xx-svar tæller som leveret.
  • Hvis dit endpoint returnerer en 5xx-fejl, 408 eller 429 eller ikke svarer inden for 10 sekunder, prøver Foliant igen senere og venter længere hver gang, op til 5 forsøg.
  • Andre 4xx-svar er endelige: Foliant prøver dem ikke igen.
  • Hver hændelse leveres én gang pr. dokument eller eksport. Nye forsøg sender den aldrig to gange efter en vellykket levering.
Hver levering vises under Aktivitet på integrationens side, hvor du kan klikke på Prøv igen ved en mislykket levering. Se Integrationsaktivitet.

Relaterede artikler