Webhooks
Webhooks leverer ordre- og sendeinformasjon til et eksternt system når visse begivenheter oppstår. Bruk webhooks til å holde eksterne systemer oppdatert med sende- og sporingsdata etter at ordrene er behandlet. Ditt eksterne system må støtte webhooks og kunne motta data på en URL-endpoint.
Viktige begreper
Begivenhet — en handling i systemet som utløser en webhook når den inntreffer, slik som Ordre opprettet eller Sending opprettet
Ordrekanal – en forbindelse mellom nShift Delivery og en ekstern ordrekilde
Opprett en webhook
Opprett en webhook for å levere ordre- og sendinginformasjon til et eksternt system når en valgt begivenhet inntreffer.
Trinn
Gå til
Velg
Skriv inn et navn for webhooken
Skriv inn URL-endpointen
Velg en begivenhet i Trigger
Velg ordrekanalene for webhooken
Velg
Resultat
Webhook’en er opprettet og vises i webhookslisten.
Feltbeskrivelser
Felt | Beskrivelse |
|---|---|
Navn | Identifiserer webhooken i webhookslisten |
URL | Endpointet som mottar webhook-payloaden — må bruke HTTPS-format |
Aktiv | Aktiverer eller deaktiverer webhooken — aktivert som standard |
Hendelse | Handlingen som utløser webhook-payloaden |
Ordrekanaler | Ordrekanalene webhooken gjelder — alle ordrekanaler er aktivert som standard |
Hendelser
- Ordre opprettet
Utløses når en ny ordre opprettes
- Ordre oppdatert
Utløses når en ordre oppdateres
- Ordre slettet
Utløses når en ordre slettes
- Sending opprettet
Utløses når en sending opprettes fra en ordre
Vis webhook-begivenheter
Vis webhook-begivenheter for å sjekke leveringsstatusen for payloads sendt til det eksterne systemet.
Trinn
Gå til
Velg
ved siden av webhookVelg Begivenheter
Webhook-begivenhetssiden viser statusen for hver begivenhet utløst av webhooken, inkludert svarskode, siste forsøk, og antall forsøk.
Rediger en webhook
Rediger en webhook for å oppdatere endpoint-URL-en, begivenhet eller ordrekanaler.
Trinn
Gå til
Velg
ved siden av webhookVelg Rediger
Oppdater de relevante feltene
Velg
Slett en webhook
Slett en webhook for å fjerne den fra kontoen din
Notat
Sletting av en webhook er permanent og kan ikke angres.
Trinn
Gå til
Velg
ved siden av webhookVelg Slett
Oppdater de relevante feltene
Velg
Relaterte artikler
Ordrekanaler – Konfigurer og administrer forbindelser til eksterne systemer