Webhooks

Wir bieten die 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 und den Bezeichner sowie den Typ des Objekts an.

Dieses Beispiel 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",
        "email": "guan@example.com",
        "name_first": "Guan",
        "name_infix": null,
        "name_last": "the Man",
        "gender": "man",
        "company_name": "EventInsight",
        "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 der Operation, die ausgeführt wurde, die Optionen sind new, update und delete.

result ist der neue Wert des Datensatzes, die Felder sind dieselben wie in https://docs.eventinsight.io (diese Daten werden bei einer Löschaktion nicht bereitgestellt.

  1. Installation Im Adminbereich von EventInsight anmelden

  2. Auf Einstellungen -> Integrationen -> Koppelungen gehen

  3. Auf die Schaltfläche Neuer Webhook klicken

  4. Einen Namen eingeben, dieser dient nur als Beschreibung, bitte geben Sie den Namen des Dienstes an, 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. Aktivieren Sie alle Auslöser, die Sie empfangen möchten

Events auswählen

Auf der Einstellungsseite kann ausgewählt werden, welche Veranstaltungen an Ihren Endpunkt gesendet werden.

Webhooks deprogrammieren

Wir bieten zwei Funktionen zum Debugging 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.

Last updated