Skip to main content

nShift Delivery Help Center

Webhooks

Webhooks levererar order- och sändningsinformation till ett externt system när vissa händelser inträffar. Använd webhooks för att hålla externa system uppdaterade med sändnings- och spårningsinformation efter att ordrar har behandlats. Ditt externa system måste stödja webhooks och kunna ta emot data på en URL-endpoint.

Centrala begrepp

Händelse — en åtgärd i systemet som utlöser en webhook när det inträffar, såsom Order skapad eller Sändning skapad

Orderkanal – en anslutning mellan nShift Delivery och en extern orderkälla

Skapa en webhook

Skapa en webhook för att leverera order- och sändningsinformation till ett externt system när en vald händelse inträffar.

Steg

  1. Gå till Orderhantering > Webhooks

  2. Välj Lägg till webhook

  3. Ange ett namn för webhooken

  4. Ange URL-endpointen

  5. Välj en händelse i Utlösare

  6. Välj orderkanaler för webhooken

  7. Välj Skapa

Resultat

Webhooken har skapats och visas i listan över webhooks.

Fältbeskrivningar

Fältnamn

Beskrivning

Namn

Identifierar webhooken i listan över webhooks

URL

Endpoint som tar emot webhookens payload — måste använda HTTPS-format

Aktiv

Aktiverar eller inaktiverar webhooken — aktiverad som standard

Händelse

Åtgärden som triggar webhookens payload

Orderkanaler

Orderkanalerna som webhooken gäller för — alla orderkanaler är aktiverade som standard

Händelser

Order skapad

Triggas när en ny order skapas

Order uppdaterad

Triggas när en order uppdateras

Order raderad

Triggas när en order raderas

Sändning skapad

Triggas när en sändning skapas från en order

Visa webhook-händelser

Visa webhook-händelser för att kontrollera leveransstatusen för payloads som skickas till det externa systemet.

Steg

  1. Gå till Orderhantering > Webhooks

  2. Välj DEL_Kebab_icon.png bredvid webhooken

  3. Välj Händelser

Sidan för webhook-händelser visar status för varje händelse som triggas av webhooken, inklusive svarskod, senaste försök och antal försök.

Redigera en webhook

Redigera en webhook för att uppdatera dess URL-endpoint, händelse eller orderkanaler.

Steg

  1. Gå till Orderhantering > Webhooks

  2. Välj DEL_Kebab_icon.png bredvid webhooken

  3. Välj Redigera

  4. Uppdatera de relevanta fälten

  5. Välj Uppdatera

Radera en webhook

Radera en webhook för att ta bort den från ditt konto

Notera

Att radera en webhook är permanent och kan inte återställas.

Steg

  1. Gå till Orderhantering > Webhooks

  2. Välj DEL_Kebab_icon.png bredvid webhooken

  3. Välj Radera

  4. Uppdatera de relevanta fälten

  5. Välj Uppdatera

Relaterade ämnen

Orderkanaler – Konfigurera och hantera anslutningar till externa system

I detta avsnitt: