Webhookit
Webhookit toimittavat tilausta ja lähetystä koskevia tietoja ulkoiseen järjestelmään, kun tietyt tapahtumat tapahtuvat. Käytä webhookeja pitääksesi ulkoiset järjestelmät ajan tasalla lähetys- ja seurantatiedoilla tilausten käsittelyn jälkeen. Ulkoisen järjestelmäsi on tuettava webhookeja ja pystyttävä vastaanottamaan tietoja endpoint-URL-osoitteessa.
Keskeiset käsitteet
Tapahtuma — toiminto järjestelmässä, joka laukaisee webhookin, kun se tapahtuu, kuten Tilaus luotu tai Lähetys luotu
Tilauskanava – Yhteys nShift Delivery ja ulkoinen tilauslähde
Luo webhook
Luo webhook, joka toimittaa tilauksen ja lähetyksen tietoja ulkoiseen järjestelmään, kun valittu tapahtuma tapahtuu.
Vaiheet
Siirry kohtaan >
Valitse
Anna nimi webhookille
Anna endpoint-URL
Valitse tapahtuma kohdassa Laukaisin
Valitse webhookin tilauskanavat
Valitse
Tulokset
Webhook on luotu ja näkyy Webhooks-luettelossa.
Kenttien kuvaus
Kentän nimi | Kuvaus |
|---|---|
Nimi | Tunnistaa webhookin Webhooks-luettelossa |
URL | Endpoint, joka vastaanottaa webhook-payloadin — HTTPS-muotoa on käytettävä |
Aktiivinen | Ottaa webhookin käyttöön tai poistaa sen käytöstä — oletuksena käytössä |
Tapahtuma | Toiminto, joka laukaissee webhook-payloadin |
Tilauskanavat | Tilauskanavat, joihin webhook koskee — kaikki tilauskanavat ovat oletuksena käytössä |
Tapahtumat
- Tilaus luotu
Laukaistaan, kun uusi tilaus luodaan
- Tilaus päivitetty
Laukaistaan, kun tilausta päivitetään
- Tilaus poistettu
Laukaistaan, kun tilaus poistetaan
- Lähetys luotu
Laukaistaan, kun lähetys luodaan tilauksesta
Näytä webhook-tapahtumat
Näytä webhook-tapahtumat tarkistaaksesi ulkoiseen järjestelmään lähetettyjen payloadien toimitustilan.
Vaiheet
Siirry kohtaan >
Valitse
webhookin vieressäValitse Tapahtumat
Webhook-tapahtumasivu näyttää tilan kaikille webhookin laukaisemille tapahtumille, mukaan lukien vastauskoodi, viimeisin yritys ja yritysten lukumäärä.
Muokkaa webhookia
Muokkaa webhookia päivittääksesi sen endpoint-URL-osoitetta, tapahtumaa tai tilauskanavia.
Vaiheet
Siirry kohtaan >
Valitse
webhookin vieressäValitse Muokkaa
Päivitä asiaankuuluvat kentät
Valitse
Poista webhook
Poista webhook poistaaksesi sen tililtäsi
Huomaa
Webhookin poistaminen on pysyvää eikä sitä voi perua.
Vaiheet
Siirry kohtaan >
Valitse
webhookin vieressäValitse Poista
Päivitä asiaankuuluvat kentät
Valitse
Aiheeseen liittyvät aiheet
Tilauskanavat – Konfiguroi ja hallitse yhteyksiä ulkopuolisiin järjestelmiin