WebHooks

Mit WebHooks erhalten Sie Benachrichtigungen aus Vizito in Echtzeit über verschiedene Ereignisse in Ihrem Konto. Dieser Artikel führt Sie durch die Einrichtung von WebHooks und erklärt, welche Ereignisse und Daten sie liefern.

Was sind WebHooks in Vizito?

WebHooks sind automatische Nachrichten, die Vizito bei bestimmten Ereignissen an eine von Ihnen angegebene URL sendet. Damit können Sie Vizito mit anderen Systemen oder Diensten verbinden und in Echtzeit auf diese Ereignisse reagieren. Hinweis: WebHooks sind nur im Enterprise-Tarif verfügbar.

Welche Ereignisse können WebHooks senden?

WebHooks lassen sich für die folgenden Ereignisse konfigurieren:

  • company_updated
  • device_added
  • device_online
  • device_offline
  • device_deleted
  • registered_visitor_created
  • registered_visitor_updated
  • registered_visitor_deleted
  • registered_visitor_preregistered
  • visitor_signed_in
  • visitor_signed_out
  • visitor_updated
  • visitor_screening_approved
  • visitor_screening_rejected

Parameter je Ereignis

Die folgende Tabelle listet die Parameter auf, die mit jedem Ereignis gesendet werden:

Ereignis Parameter
company_updated companyId
device_added companyId
deviceUuid
device_online companyId
deviceUuid
device_offline companyId
deviceUuid
device_deleted companyId
deviceUuid
registered_visitor_created companyId
knownVisitorId
visitTypeId
registered_visitor_updated companyId
knownVisitorId
visitTypeId
registered_visitor_deleted companyId
knownVisitorId
visitTypeId
registered_visitor_preregistered companyId
knownVisitorId
visitor_signed_in companyId
visitTypeId
visitorId
knownVisitorId
visitor_signed_out companyId
visitTypeId
visitorId
knownVisitorId
visitor_updated companyId
visitTypeId
visitorId
knownVisitorId
visitor_screening_approved companyId
visitorId
approvalStatus
knownVisitorId
visitor_screening_rejected companyId
visitorId
approvalStatus
knownVisitorId

WebHooks in Vizito einrichten

Folgen Sie diesen Schritten, um WebHooks im Vizito-Backoffice zu konfigurieren:

Schritt 1: Die Seite Integrationen öffnen

Melden Sie sich auf der Integrationsseite im Vizito-Backoffice an.

Schritt 2: Webhook aktivieren

  • Gehen Sie zum Abschnitt “Webhook”.
  • Schalten Sie “Webhook aktivieren” ein.

Schritt 3: Die Webhook-Einstellungen konfigurieren

  • Webhook-URL: Geben Sie die URL ein, an die Vizito die Webhook-Daten senden soll (zum Beispiel https://example.com/webhook).
  • HTTP-Methode: Wählen Sie die HTTP-Methode (zum Beispiel POST, GET, PUT, PATCH). Empfohlen wird POST.
  • Benutzername (fakultativ): Hinterlegen Sie bei Bedarf einen Benutzernamen für die Basisauthentifizierung.
  • Passwort (fakultativ): Hinterlegen Sie bei Bedarf ein Passwort für die Basisauthentifizierung.

Schritt 4: Konfiguration speichern

  • Klicken Sie auf “Speichern”, um die Einstellungen zu übernehmen.

Schritt 5: Den Webhook testen

  • Führen Sie in Vizito eine Aktion aus, die eines der Webhook-Ereignisse auslöst (zum Beispiel eine Besucheranmeldung).
  • Prüfen Sie, ob Ihre Webhook-URL die erwarteten Daten empfängt.

Fehlerbehebung

  • Keine Daten empfangen: Prüfen Sie, ob die Webhook-URL korrekt und erreichbar ist. Kontrollieren Sie Firewall- und Netzwerkeinstellungen.
  • Ungültige HTTP-Methode: Vergewissern Sie sich, dass Ihr Endpunkt die gewählte Methode unterstützt.
  • Authentifizierungsprobleme: Prüfen Sie Benutzername und Passwort, falls Sie sie verwenden.

Weitere Hinweise

  • WebHooks werden als HTTP-Anfragen mit einer JSON-Nutzlast gesendet, die die Ereignisdaten enthält.
  • Achten Sie darauf, dass Ihr Endpunkt das Anfragevolumen bewältigt, besonders zu Spitzenzeiten.
  • Wenn Sie nicht im Enterprise-Tarif sind und WebHooks nutzen möchten, sprechen Sie uns an, um Ihr Abonnement zu erweitern.