Skip to main content

nShift Delivery Help Center

Webhooks

Webhooks leverer ordre- og forsendelsesinformation til et eksternt system, når bestemte begivenheder indtræffer. Brug webhooks til at holde eksterne systemer opdateret med forsendelses- og sporingsdata efter, at ordrer er behandlet. Dit eksterne system skal understøtte webhooks og være i stand til at modtage data på en URL-endpoint.

Vigtige begreber

Begivenhed — en handling i systemet, der udløser en webhook, når det sker, såsom Ordre oprettet eller Forsendelse oprettet

Ordrekanal – En forbindelse mellem nShift Delivery og en ekstern ordrekilde

Opret en webhook

Opret en webhook for at levere ordre- og forsendelsesinformation til et eksternt system, når en valgt begivenhed opstår.

Trin

  1. Gå til Ordreadministration > Webhooks

  2. Vælg Tilføj webhook

  3. Indtast et navn til webhooken

  4. Indtast URL-endpointen

  5. Vælg en begivenhed i Udløser

  6. Vælg ordrekanalerne for webhooken

  7. Vælg Opret

Resultat

Webhooken er oprettet og vises i Webhooks-listen.

Feltbeskrivelser

Feltnavn

Beskrivelse

Navn

Identificerer webhooken i Webhooks-listen

URL

Endpointet, der modtager webhook-payloaden — skal bruge HTTPS-format

Aktiv

Aktiverer eller deaktiverer webhooken — aktiveret som standard

Begivenhed

Handling som affyrer webhook payload

Ordrekanaler

Ordrekanalerne webhooken gælder til — alle ordrekanaler er aktiveret som standard

Begivenheder

Ordre oprettet

Udløses når en ny ordre oprettes

Ordre opdateret

Udløses når en ordre opdateres

Ordre slettet

Udløses når en ordre slettes

Forsendelse oprettet

Udløses når en forsendelse oprettes fra en ordre

Vis webhook begivenheder

Vis webhook begivenheder for at kontrollere leveringsstatus for payloads sendt til det eksterne system.

Trin

  1. Gå til Ordreadministration > Webhooks

  2. Vælg DEL_Kebab_icon.png ved siden af webhook

  3. Vælg Begivenheder

Webhook-begivenheder-siden viser status for hver begivenhed udløst af webhooken, inklusiv svar kode, seneste forsøg, og antal forsøg.

Rediger en webhook

Rediger en webhook for at opdatere dens endpoint-URL, begivenhed eller ordrekanaler.

Trin

  1. Gå til Ordreadministration > Webhooks

  2. Vælg DEL_Kebab_icon.png ved siden af webhook

  3. Vælg Rediger

  4. Opdater de relevante felter

  5. Vælg Opdater

Slet en webhook

Slet en webhook for at fjerne den fra din konto

Bemærk

Sletning af en webhook er permanent og kan ikke fortrydes.

Trin

  1. Gå til Ordreadministration > Webhooks

  2. Vælg DEL_Kebab_icon.png ved siden af webhook

  3. Vælg Slet

  4. Opdater de relevante felter

  5. Vælg Opdater

Relaterede emner

Ordrekanaler – Konfigurer og administrer forbindelser til eksterne systemer

I dette afsnit: