Help

Webhooks offer a powerful mechanism for integrating and automating processes across different applications and services. Elements supports executing custom webhooks as actions on automations. For example, create a webhook to post a message to Microsoft Teams when a Door Forced Open event occurs, or send Device Offline events to PagerDuty or ServiceNow for further triage.

Configuration

Elements automation action webhooks support the following HTTP scheme, methods, and body content types.

URL endpoint
- Scheme must be https://
- Host must be a fully qualified domain name (FQDN); IP addresses are not allowed.
HTTP methods:
- GET
- POST
- PUT
- PATCH
- DELETE
- HEAD
Body content types:
- application/json
- application/xml
- text/plain

Context

Enrich webhooks with context from the event that triggered the automation.

Available Variables

Trigger Context

id
eventType
eventTypeLocalized
severity
severityLocalized
timestamp (example: 1717768279000)
dateTimeLong (example: Friday, June 07 at 09:51:19 AM)
timeZone (example: America/New_York)
device.id
device.name
device.type
space.id
space.name
person.id
person.firstName
person.lastName
person.customFields.department
- Custom person fields may be configured in System Options.
credential.id
credential.badgeId
lockdownProfile.id
lockdownProfile.name

Usage

Reference context variables in webhook URLs and body payloads like {{context.trigger.device.name}}. See sample webhook payloads below for more examples.

Request Details

Webhooks include the following request headers to facilitate system integration:

	Name	Value type
1	`x-elements-trigger-ts`	Unix time in milliseconds
2	`x-elements-trigger-id`	UUID
3	`x-elements-action-id`	UUID
4	`x-elements-automation-id`	UUID
5	`x-elements-correlation-id`	UUID
6	`x-elements-account-id`	UUID

Additionally, the user-agent header will be set to elements.

Sample Webhook Payloads

For your convenience, we have created a selection of sample webhook payloads for popular services. Either copy and paste these as-is into a webhook body, or customize them to meet your needs. For more detailed information, refer to each service’s respective documentation.