Webhooks aanmaken en beheren

Pingen biedt automatische meldingen via webhooks voor belangrijke gebeurtenissen. Je wordt bijvoorbeeld in real-time op de hoogte gesteld zodra een brief is verzonden, een probleem heeft of als onbestelbaar is gemeld. Dit stelt je in staat om verdere acties automatisch uit te voeren zonder de Pingen API actief te hoeven 'pollen' voor wijzigingen.

Webhooks aanmaken

Webhooks kunnen direct in de Pingen WebApp worden aangemaakt via het menu-item "Organisatiemanagement" --> "Webhooks" door op de knop "Voeg je eerste Webhook toe" te klikken.

Kies vervolgens de gewenste gebeurtenis voor de webhook. Pingen biedt de volgende categorieën:

• Problemen met brieven: Alle gebeurtenissen die te maken hebben met problemen bij het verzenden van een brief. Dit kan bijvoorbeeld gaan om: een PDF die niet in A4-formaat is, inhoud in de niet-afdrukbare zones, of onvoldoende beschikbare credits.
• Verzonden brieven: Alle gebeurtenissen met betrekking tot de postbezorging, bijvoorbeeld: wanneer een brief aan de post is overgedragen of wanneer een post-tracking-ID is ontvangen.
• Onbestelbare brieven: Alle gebeurtenissen die informatie bevatten over waarom een brief niet door de post kon worden bezorgd.
• Bezorgde brieven: Events met betrekking tot de verzending van brieven met bezorgbevestiging (zoals aangetekende brieven).

Zodra een gebeurtenis is gekozen, moet de Webhook-URL (de URL waar Pingen de webhooks naartoe moet sturen) en een Signature Secret worden opgegeven. Voor de Webhook-URL is het essentieel dat deze bereikbaar is via poort 443. Het Secret wordt gebruikt om ervoor te zorgen dat alleen gegevens van betrouwbare bronnen worden verwerkt. Elke willekeurige tekenreeks (max. 32 tekens) kan worden gebruikt als Secret. Als je een Secret opgeeft, zorg er dan voor dat deze waarde wordt gevalideerd bij het verwerken van de webhooks.

Webhooks beheren

Het beheren van de webhooks kan direct in de Pingen web app worden geopend via het menu-item "Organisatiemanagement" --> "Webhooks" door op de desbetreffende webhook te klikken.

Het webhooksbeheer biedt een overzicht van alle tot nu toe verzonden verzoeken. In de rechterbovenhoek kun je ook een Testwebhook verzenden of Mislukte verzoeken opnieuw verzenden.

Het overzicht toont de belangrijkste informatie en de status van het verzoek. Verzoeken kunnen de volgende statussen hebben:

• Succes: Webhook is succesvol afgeleverd.
• Opnieuw proberen: Webhook is nog niet succesvol afgeleverd, maar Pingen probeert de levering maximaal 7 keer opnieuw.
• Mislukt: Webhook kon ondanks de herhaalde pogingen niet succesvol worden afgeleverd.

Door op een verzoek te klikken, kun je de detailweergave van het betreffende verzoek openen:

In de detailweergave zie je zowel de inhoud van het verzoek als de desbetreffende reactie van de doel-URL. Webhooks met de status "Mislukt" kunnen ook direct opnieuw worden verzonden via de link in de zijbalk.

Webhooks verwijderen

Webhooks kunnen direct in de Pingen WebApp worden verwijderd via het menu-item "Organisatiemanagement" --> "Webhooks". Beweeg eenvoudig de muis over de gewenste webhook en klik op het prullenbakpictogram: