Introduction

This manual describes the webhooks feature.

Webhooks are HTTP requests that enable web applications to communicate with each other and facilitates the sending of real-time data from one application to another when a predefined event occurs, for example sending event data to a predefined webhook endpoint when a user logs on to the system or when a camera reports an error.

A webhook endpoint (webhook URL) is the predefined address which the event data is to be sent to, much like a one-way telephone number.

You can use webhooks to build integrations which subscribe to selected events in XProtect. When an event is triggered, an HTTP POST is sent to the webhook endpoint you have defined for that event. The HTTP POST body contains event data in JSON.

Webhooks do not poll the system for data or triggered events, instead, the system pushes event data to the webhook endpoint when an event occurs which makes webhooks less resource-demanding and faster to set up compared to polling-solutions.

Webhooks can be set up to integrate with or without using code scripts.

You should verify that the event data sent from XProtect complies with the existing data and privacy protection legislation of your country.