---
title: "WebHooks | Vizito Help Center"
description: "WebHooks | Configure and manage WebHooks to receive real-time updates from Vizito. | Vizito | Visitor management system"
url: https://vizito.eu/faq/integrations/webhook/
language: en
---

# 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`
`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` |

### 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](https://backoffice.vizito.be/#/app/integrations).

#### 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.