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

By setting up a webhook in alarm management, you can send notifcaitons automatically to the URLs you specify everytime when a rule you care about is triggered.

In Alarm management, you will find a button to create webhook profile.

• On the setting page, you can choose the webhook to be sent from VORTEX device or from 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
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.
Timezone	Timezone
eventType	Type of event that triggered. It is the event you see in alarm management.

Example 1

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

Example 2

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