Over webhooks
Een webhook is een door de gebruiker gedefinieerde HTTP-callback. Een webhook kan worden geactiveerd door een gebeurtenis in een webtoepassing en kan worden gebruikt om gegevens of meldingen te verzenden naar een API (Application Programming Interface) van derden.
Webhooks in ClearID
Er kan bijvoorbeeld een e-mailmelding met een koppeling naar gedetailleerde informatie over een identiteit worden verzonden wanneer zich een gebeurtenis voordoet waarbij een identiteit is bijgewerkt of als u wilt dat andere belanghebbenden op de hoogte worden gesteld nadat een identiteitsverzoek is aangemaakt of een identiteitsverzoek is bijgewerkt.
Verwerking van webhooks
Nadat de webhook is gemaakt, luistert de webhookservice naar een subset van gespecificeerde gebeurtenissen die afkomstig zijn van andere ClearID-services. Wanneer de opgegeven gebeurtenis optreedt, stelt de webhookservice de API op de hoogte die is opgegeven in het veld URL van het gedeelte Webhookdetails.
Schema's voor webhookgebeurtenissen
Het schema beschrijft het object dat via de webhook wordt verzonden en de inhoud van het schema varieert afhankelijk van het opgegeven gebeurtenistype. Het webhookgebeurtenisschema kan worden gedownload vanuit het gedeelte Gebeurtenis van de webhook om inzicht te krijgen in de gegevensstructuur van de gebeurtenissen, zodat deze correct kunnen worden opgehaald en verwerkt aan de gebruikerszijde van de webhookintegratie.
Zie voor meer informatie over het downloaden van het schema.Webhooks maken
Webhooklogboeken
Externe API-eigenaren kunnen webhooklogboeken gebruiken om de status te verifiëren van elk HTTP-callbackverzoek dat naar de externe URL wordt verzonden en om niet-ontvangen webhooks of andere bijbehorende problemen op te lossen. Bijvoorbeeld problemen met afzenders, ontvangers, enzovoort.
- Callbackdatum
- Wanneer de callback is verzonden (inclusief datumbereikfilters).
- URL
- De URL die wordt gebruikt om de webhookgebeurtenismelding door te sturen naar de relevante API (programma of applicatie) van derden.
- Antwoord
- De antwoordstatus geeft aan of de API van derden de HTTP-callback heeft ontvangen of niet. Bijvoorbeeld geaccepteerd, ongeldig verzoek, interne serverfout, enzovoort.
