Informationen zu Webhooks
Ein Webhook ist ein benutzerdefinierter HTTP-Rückruf. Ein Webhook kann durch ein Ereignis in einer Webanwendung ausgelöst werden und dazu verwendet werden, Daten oder Benachrichtigungen an eine Drittanbieter-API (Application Programming Interface) zu senden.
Webhooks in ClearID
Beispielsweise könnte eine E-Mail-Benachrichtigung mit einem Link zu detaillierten Informationen über eine Identität gesendet werden, wenn ein Ereignis vom Typ Identität aktualisiert eintritt oder wenn Sie möchten, dass andere Beteiligte benachrichtigt werden, nachdem ein Ereignis vom Typ Identitätsanfragen erstellt oder Identitätsanfragen aktualisiert eingetreten ist.
Webhook-Verarbeitung
Nachdem der Webhook erstellt wurde, überwacht der Webhook-Dienst eine Teilmenge der spezifizierten Ereignisse, die von anderen ClearID-Diensten stammen. Wenn das angegebene Ereignis eintritt, benachrichtigt der Webhook-Dienst die API, die im URL-Feld des Abschnitts Webhookdetails angegeben ist.
Webhook-Ereignisschemata
Das Schema beschreibt das Objekt, das über den Webhook gesendet wird, und der Inhalt des Schemas variiert je nach angegebenem Ereignistyp. Das Webhook-Ereignisschema kann aus dem Abschnitt Ereignis des Webhooks heruntergeladen werden, um die Datenstruktur der Ereignisse zu verstehen, damit sie auf der Benutzerseite der Webhook-Integration ordnungsgemäß abgerufen und verarbeitet werden können.
Weitere Hinweise zum Herunterladen des Schemas finden Sie unter Erstellen von Webhooks.
Webhook-Protokolle
Eigentümer von Drittanbieter-APIs können Webhook-Protokolle verwenden, um den Status jeder HTTP-Rückruf-Anforderung zu überprüfen, die an die Drittanbieter-URL gesendet wird, und um nicht empfangene Webhooks oder andere damit verbundene Probleme zu beheben. Zum Beispiel Absenderprobleme, Empfängerprobleme usw.
- Rückrufdatum
- Wann der Rückruf gesendet wurde (einschließlich Datumsbereichsfilter).
- URL
- Die URL, die verwendet wird, um die Webhook-Ereignisbenachrichtigung an die entsprechende Drittanbieter-API (Programm oder Anwendung) weiterzuleiten.
- Reaktion
- Der Antwortstatus gibt an, ob die Drittanbieter-API den HTTP-Rückruf erfolgreich erhalten hat oder nicht. Beispiele hierfür sind „Akzeptiert“, „Ungültige Anfrage“, „interner Serverfehler“ usw.
