Webhooks

Wir bieten eine Möglichkeit, Benachrichtigungen von unserem System zu erhalten, wenn ein Benutzer oder eine Firma geändert wird. Hierfür verwenden wir ein Konzept namens Webhooks. Wenn Sie einen Webhook in unserem System aktivieren, wird eine bestimmte von Ihnen angegebene Seite geöffnet, damit Sie Ihr System entsprechend aktualisieren können. Im Webhook geben wir die Art der Operation, den Bezeichner und den Typ des Objekts an.

Dieses Beispiel einer POST-Anfrage:

{    "entity_id": 1,    "entity_type": "user",    "action_type": "new",    "result": {        "id": 1,        "external_id": "1815",        "code": "CODE",        "external_qr_identifier": "thebarcode",        "checkin": "2019-11-05 07:56:15",        "name_first": "Guan",        "name_infix": null,        "name_last": "the Man",        "gender": "man",        "company_name": "Let's Get Digital",        "company_role": "Awesome person",        "normal_qr_code": "thebarcode",        "secure_qr_code": "https:\/\/evins.nl\/1\/bd0494941c\/tyiuW2S1OUv5c3ASL1qv%2E",        "aanmelder_survey_id": "93627",        "qr_link": "v2d5iy6g0m60tc",        "custom_fields": [],        "companies": [            5        ]    }}

entity_id ist unser interner Bezeichner für diesen Eintrag

entity_type ist der Typ der Entität, derzeit unterstützen wir Benutzer und Unternehmen

action_type ist die Art des Vorgangs, der ausgeführt wurde, die Optionen sind new, update und delete.

Ergebnis ist der neue Wert des Datensatzes, die Felder sind die gleichen wie in unserer API (diese Daten werden bei einer Löschaktion nicht bereitgestellt.

Installieren Sie

1. Melden Sie sich im Administrationsbereich an.

2. Gehen Sie zu Einstellungen -> Integrationen -> Kopplungen

3. Drücken Sie auf die Schaltfläche Neuer Webhook

4. Geben Sie einen Namen ein, dieser dient nur als Beschreibung, bitte geben Sie den Namen des Dienstes ein, den Sie koppeln möchten.

5. Setzen Sie Is active auf Active, um den Webhook zu aktivieren

6. Geben Sie die URL des Endpunkts ein

7. Und aktivieren Sie alle Auslöser, die Sie empfangen möchten

Ereignisse auswählen

Auf der Einstellungsseite können Sie auswählen, welche Ereignisse an Ihren Endpunkt gesendet werden.

Webhaken debuggen

Wir bieten zwei Funktionen zum Debuggen eines Webhooks. Die erste ist eine Test-Webhook-Schaltfläche. Wenn Sie diesen drücken, wird eine Anfrage an die angegebene URL mit einem action_type: test abgefeuert.

Diese Anfrage sendet die Daten Ihres Benutzerkontos. Das andere Debug-Tool ist die Log-Übersicht, in der Sie die letzten 10 Webhook-Anfragen sehen können, um zu sehen, ob sie richtig funktionieren.

Sie können auch eine Website wie https://webhook.site/ verwenden, um Anfragen zu testen, die von unserem System kommen.