Webhooks

Webhooks allow you to receive real-time notifications from Vizito about various events occurring in your account. This FAQ will guide you through setting up webhooks and understanding the events and data they provide.

What are Webhooks in Vizito?

Webhooks are automated messages sent from Vizito to a specified URL when certain events occur. This enables you to integrate Vizito with other systems or services to react to these events in real-time. Note: Webhooks are only available in the Enterprise subscription tier.

What Events Can Webhooks Send?

Webhooks can be configured to send the following events:

  • 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

Parameters for Each Event

The following table lists the parameters sent with each event:

Event Parameters
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
visitor_signed_out companyId
visitTypeId
visitorId
visitor_updated companyId
visitTypeId
visitorId
visitor_screening_approved companyId
visitorId
approvalStatus
visitor_screening_rejected companyId
visitorId
approvalStatus

How to Set Up Webhooks in Vizito

Follow these steps to configure webhooks in the Vizito backoffice:

Step 1: Access the Integrations Page

Log in to the Vizito Backoffice Integrations page.

Step 2: Enable Webhook

  • Navigate to the “Webhook” section.
  • Toggle the “Enable Webhook” switch to the on position.

Step 3: Configure Webhook Settings

  • Webhook URL: Enter the URL where Vizito should send the webhook data (e.g., https://example.com/webhook).
  • HTTP Method: Select the HTTP method (e.g., POST, GET, PUT, PATCH). POST is recommended.
  • Username (optional): Provide a username for basic authentication if required.
  • Password (optional): Provide a password for basic authentication if required.

Step 4: Save Configuration

  • Click the “Save” button to apply the settings.

Step 5: Test the Webhook

  • Perform an action in Vizito that triggers one of the webhook events (e.g., signing in a visitor).
  • Verify that your webhook URL receives the expected data.

Troubleshooting

  • No Data Received: Ensure the Webhook URL is correct and accessible. Check firewall or network settings.
  • Invalid HTTP Method: Confirm the selected method is supported by your endpoint.
  • Authentication Issues: Verify the username and password if used.

Additional Notes

  • Webhooks are sent as HTTP requests with a JSON payload containing the event data.
  • Ensure your endpoint can handle the volume of requests, especially during peak usage.
  • If you are not on the Enterprise tier and would like to use webhooks, please get in touch with us to upgrade your subscription tier.