Overslaan en naar hoofdcontent gaan
Terug naar boven

Wat zijn webhooks en hoe gebruik je deze in combinatie met Sendcloud?

Joan
  • Bijgewerkt

Doel: leer de basis over webhooks en hoe je ze kunt configureren in je Sendcloud panel.

Om webhooks te kunnen gebruiken moet je via een API verbinding maken met Sendcloud. Voor meer informatie over het verbinden met onze API, verwijzen we je naar onze API Documentatie.

Voor meer informatie over Sendcloud webhooks, zie de Webhooks secties in onze API-documentatie. 

Wat zijn webhooks?

Webhooks maken het mogelijk voor applicaties om met elkaar te communiceren in 'real time'. Een andere manier voor applicaties om te communiceren is via een API. In tegenstelling tot een API die werkt met polling, ontvangt een webhook gegevens zodra de applicaties het afhandelt. Er hoeft geen request te worden gedaan, omdat het een automatisch proces is. Daarom hoef je je geen zorgen te maken over een vertraging in de communicatie.

API: een API haalt periodiek gegevens uit de applicatie door een request te doen.

Webhook: een webhook pulled geen gegevens uit de applicatie, maar krijgt gegevens uit de applicatie gepusht zodra het incident zich voordoet.

Voorbeeld: tracking updates ontvangen van Sendcloud

(Zie onderstaande afbeeldingen ter referentie)

  1. Als je tracking updates ontvangt via de API gaat het als volgt:
    Je applicatie probeert via interval trackinggegevens uit Sendcloud te pullen. Dat doet het zelfs als er geen nieuwe gegevens beschikbaar zijn.
  2. Wanneer je tracking updates wilt ontvangen via een webhook gaat het als volgt:
    Sendcloud pusht de tracking-updates naar je applicatie zodra deze beschikbaar zijn in Sendcloud.

Sendcloud webhooks

Webhook Integration Object: deze webhook komt in actie wanneer een nieuwe API-integratie wordt toegevoegd aan Sendcloud. Hij wordt geactiveerd wanneer een API integratie wordt aangesloten, verwijderd of bijgewerkt. Klik hier om te zien wat er in de payload van deze webhook staat.

Webhook Parcel Status Changed Object: deze webhook komt in beeld in wanneer de status van een zending verandert; ongeacht wat de statusverandering is. Klik hier om te zien wat er in de payload van deze webhook staat.

Webhook Refund Requested Object: deze webhook komt in actie wanneer een restitutie wordt aangevraagd. Klik hier om te zien wat er in de payload van deze webhook zit.

Hoe stel je webhooks in Sendcloud in?

Om Sendcloud actief zending updates te laten communiceren (zoals tracking updates), moet je een API endpoint aanmaken. Telkens als er een update plaatsvindt, zal Sendcloud een verzoek doen via dat endpoint. Zie voor meer informatie de Webhooks sectie in onze API documentatie. 

  1. Kopieer de webhook url van je applicatie naar je klembord
  2. Ga naar je Sendcloud panel en open je Integratie instellingen door naar Instellingen > Integraties > Configureren te gaan
  3. Selecteer het vakje bij Webhook feedback ingeschakeld
  4. Zoek het veld Webhook url (zie afbeelding hieronder) en plak daar je webhook url in
  5. Test je webhook door op de Test API webhook knop te klikken
  6. Klik op Opslaan

Klaar! Je webhook is nu ingesteld en de payload zou binnen moeten komen bij je applicatie. Je kunt dit gebruiken om triggers in te stellen die tot bepaalde acties leiden. Een voorbeeld zou zijn om je tracking e-mails te koppelen aan de inkomende tracking updates. Zo kun je je klanten direct updates geven.

Voor retourzendingen ontvang je alleen webhook updates als de uitgaande zending is aangemaakt via de API.

Klik hier om naar onze Sendcloud API referentie te gaan en de payload van de webhook te zien.