[VORTEX Portal] How to configure webhook in alarm management?

With the webhook feature in alarm management, you can configure automatic notifications to be sent to your specified URLs whenever a selected rule is triggered. This allows you to seamlessly integrate real-time alerts into your workflow or external systems.

Setting Up a Webhook Profile in Alarm Management

In the Alarm Management section, find and click the button to create a webhook profile.

Choose Sending Method: Select whether the webhook should be sent from the VORTEX device or the server.
for payload type, select plain text or Json.
You can also add header if your system needs it.
After webhook profile is created, you can set webhook as an alarm action, and choose which profile you would like to apply.

Note

Currently, if you choose to send by cloud, IP address is not allowed for URL, use domain name instead.

Don't use language other than English, as it can cause the webhook to fail.

If the sending method is by device, make sure the receiving end and the device are on the same local network.

Below is the list of variables we have

Definition

Parameter	Description
EventId	Id of event that triggered
DeviceId	Id of the device that triggered the event
Mac	MAC address of the device that triggered the event
DeviceGroupID	Id of the Group of the device that triggered the event
EventName	Name of event that triggered
DeviceName	Name of the device that triggered the event
DeviceGroupName	Name of the Group of the device that triggered the event
OrganizationId	Organization Id from which webhook is created.
OrganizationName	Organization Name from which webhook is created.
LocalTime	Time at which event occurred. The time zone in which the cameras are physically located. It is in Unix timestamp format.
LocalISOTime	Time at which event occurred. The time zone in which the cameras are physically located. It is in ISO 8601 format.
UtcTime	UTC Time at which event occurred. It is in Unix timestamp format.
UtcISOTime	UTC Time at which event occurred. It is in ISO 8601 format.
Timezone	Timezone
EventType	Type of event that triggered. It is the event you see in alarm management.
AlarmId	Unique ID sent through the configured alarm in Alarm Management
ProfileName	Display the name of the identified person if they are a known individual; otherwise, display 'Unknown'
ImagePerson	Full-body photo of person who triggered the facial recognition; The image is provided in base64 format
ImageFace	A facial photo of the person who triggered the facial recognition The image is provided in base64 format
Object	What triggered the detection, "human" or "vehicle"
Information	Displays which configured condition was violated to trigger this event.
PersonId	Get the unique ID of the identified person
Thumbnail	A snapshot image captured at the exact moment the event was triggered.
Polygon	A set of spatial coordinates defining the precise location and boundary of the object that triggered the event within the frame.

Payload Example 1

{
"organizationName": "{{.OrganizationName}}",
"organizationId": "{{.OrganizationId}}",
"eventType": "{{.EventType}}",
"eventName": "{{.EventName}}",
"eventId": "{{.EventId}}",
"deviceName": "{{.DeviceName}}",
"deviceId": "{{.DeviceId}}",
"mac": "{{.Mac}}",
"deviceGroupName": "{{.DeviceGroupName}}",
"deviceGroupId": "{{.DeviceGroupID}}",
"localTime": {{.LocalTime}},
"timezone": "{{.Timezone}}",
"alarmId": "{{.AlarmId}}",

"profileName": "{{.ProfileName}}",

"imageFace": "{{.ImageFace}}",

"imagePerson": "{{.ImagePerson}}"

}

Payload Example 2

This is event {{.EventId}} from {{.OrganizationName}} at {{.LocalTime}}

Payload Example 3 for Teams channel Webhook

Template

{
"Text": "This is event {{.EventId}} from DeviceName: {{.DeviceName}}, at local time: {{.LocalISOTime}}, UTC time: {{.UtcISOTime}}, UNIX time:{{.UtcTime}}"
}

Note: Please add "Text" in your payload if you want to display the message in Teams channel.

Output on Teams channel

This is event 1742380260782#1d094d88-ec71-4c21-b9e9-54da735a7ffd from DeviceName: Front Door, at local time: 2025-03-19T18:31:00.782Z, UTC time: 2025-03-19T10:31:00.782Z, UNIX time:1742380260782

Add an Alarm to Send Webhook

1. Select the ‘Add alarm’ icon in the top right.

2. Select which event types that will trigger webhooks.

圖片2.png

3. Select which device sources will trigger webhooks.

螢幕擷取畫面 2025-01-06 171519.png

圖片3.png

4. Select the webhook profile you created in the previous step.

螢幕擷取畫面 2025-01-06 171950.png

5. Set the schedule for sending this webhook.

螢幕擷取畫面 2025-01-06 180049.png

6. Name this alarm and complete the setup.

螢幕擷取畫面 2025-01-06 180205.png