Hoppa till huvudinnehåll
Integrationen Webhooks är till för utvecklare. Den skickar en JSON-händelse till en HTTPS-adress som du väljer när något händer i Foliant, så att ditt eget system kan reagera. Det kan till exempel arkivera varje faktura-PDF eller hämta en färdig export. Webhooks är i beta. Om du inte ser den under Inställningar › Integrationer är den inte tillgänglig för din butik än. Kontakta supporten för att fråga om åtkomst.

Händelser

Anslut webhooks

  1. Gå till Inställningar › Integrationer i Foliant.
  2. Klicka på Anslut under Webhooks.
  3. Fyll i inställningarna:
  4. Klicka på Anslut.
Du kan ändra URL, hemlighet och händelser senare under Inställningar på integrationens sida.

Vad varje begäran innehåller

Foliant skickar en POST-begäran med en JSON-body:

Data för document.generated

  • template: mallens uuid och name.
  • document_type: invoice, credit_note, quote eller tomt för andra dokument.
  • order: dess id, name och type (ordrar eller utkastordrar).
  • refund_id och fulfillment_id, när dokumentet gäller en återbetalning eller en leverans.
  • document_number och issued_at, för numrerade dokument.
  • source: hur dokumentet skapades, till exempel download, admin_download, export eller email.
  • export: exportens ID, när dokumentet ingår i en export.
  • generated_at.

Data för export.completed

  • export: dess uuid, order_type, template_uuids, antal orders, orders_skipped (raderade efter att de valdes) och documents, requested_by (merchant eller customer) och completed_at.
  • download_url: en länk för att ladda ned exporten, och download_url_expires_at, när länken slutar fungera.
  • download_expires_at: när själva exporten går ut.
Händelser innehåller ID:n och antal, inte kunders e-postadresser.

Headers

Kontrollera signaturen

Signaturen är en hexadecimal HMAC-SHA256 av tidsstämpeln, en punkt och den råa request-bodyn (<timestamp>.<body>), med din signeringshemlighet som nyckel. Beräkna den på din sida och jämför den med värdet efter sha256= i X-Foliant-Signature. Använd den råa bodyn exakt som du tog emot den.

Svar och nya försök

  • Alla 2xx-svar räknas som levererade.
  • Om din slutpunkt returnerar ett 5xx-fel, 408 eller 429, eller inte svarar inom 10 sekunder, försöker Foliant igen senare och väntar längre varje gång, upp till 5 försök.
  • Andra 4xx-svar är slutgiltiga: Foliant försöker inte igen.
  • Varje händelse levereras en gång per dokument eller export. Nya försök skickar den aldrig två gånger efter en lyckad leverans.
Varje leverans visas under Aktivitet på integrationens sida, där du kan välja Försök igen för en misslyckad leverans. Se Integrationsaktivitet.

Relaterade artiklar