Uitgaande Webhooks
Uitgaande Webhooks zijn HTTP-callbacks die kunnen worden gebruikt om meldingen te verzenden wanneer gegevens in Print.one worden gewijzigd, waardoor externe systemen kunnen reageren op wijzigingen in deze gegevens. Een voorbeeld hiervan is het bijwerken van een CRM of het verzenden van een melding naar andere software van derden.
Overview
Triggers and payloads
De verschillende soorten triggers die door het systeem van Print.one worden verzonden, zijn te vinden in onze API-documentatie. Elk evenement toont ook een voorbeeld van de gegevens die je kunt verwachten wanneer de specifieke webhook is geactiveerd.
Timeouts
Webhookverzoeken zullen verlopen als de ontvangende server niet binnen maximaal 30 seconden reageert. Een webhookverzoek dat verloopt, wordt als mislukt beschouwd. Daarom raden we aan om webhookverzoeken asynchroon te verwerken.
Lokaal testen
Voor lokale tests raden we aan om httpdump.app te gebruiken om webhook-uitzendingen te inspecteren of ngrok te gebruiken om webhook-consumenten op je ontwikkelmachine te bouwen.
Webhooks instellen
In de zijbalknavigatie open Integrate → Webhooks. Klik op Create webhook, configureer de webhook en sla de configuratie op.
Triggers
Je kunt je webhook configureren om op meerdere gebeurtenissen te abonneren. Dit zal de webhookconfiguratie activeren als een van die triggers in ons systeem wordt gedetecteerd.
Filters
Bepaalde triggers ondersteunen filters, om de meldingen specifieker te maken. Nadat je een trigger activeert zal het 'Filters' onderdeel tonen als deze trigger filters ondersteund.
Filters kunnen tot vier verschillende 'matcher's ondersteunen.
equalsornot-equals: Deze controleren of de property gelijk is aan de aangegeven waardeinornot-in: Deze controleren of de property gelijk is aan 1 van de opgegeven waardes
Wanneeer er meerdere filters aan trigger gekoppeld worden moeten deze ALLEMAAL voldoen voor de melding verstuurd wordt.
Headers
Standaard bevatten alle webhooks de volgende headers:
Headernaam | Waarde |
|---|---|
|
|
| Webhook signature, used to validate the request |
|
|
|
|
Een webhook uitschakelen
Soms moet je een webhook uitschakelen. Je zou onderhoud kunnen plegen aan de server die webhooks ontvangt of je hebt andere problemen.
Vanuit de configuratie kun je de webhook markeren als inactief. Door het selectievakje Active uit te schakelen, zal het systeem geen webhookgebeurtenissen meer naar de externe server sturen.
Verzoek validatie
Hoe werkt de verificatie van webhookverzoeken?
Op de overzichtspagina van je webhooks vind je je webhook secret. Deze secret wordt gebruikt om een signature van de request body te genereren. Wanneer een ontvangende service een verzoek ontvangt, kan het dezelfde signature berekenen met de gedeelde secret om de oorsprong van het verzoek te valideren. Vanwege deze validatie is het belangrijk je secret niet met derden te delen.
Verzoeken verifiëren op de backend
Bij het proberen inkomende verzoeken te valideren, kan onze javascript-library hiervoor worden gebruikt. Of - je kunt dezelfde logica repliceren in elke andere programmeertaal.