A webhook is a notification action for Alert Rules. When an Alert Rule is triggered in a Kio App, the platform sends an HTTP POST request to the external URL the webhook specifies, carrying alert data in a payload you define.
How webhooks work
Webhooks are created in Company Settings and then assigned to Alert Rules in individual Kio Apps, alongside Email and SMS as notification options. A webhook request is not sent independently. It is sent as part of an Alert Rule's action when the rule's condition is met.
The setup requires two steps:
- Create the webhook in Company Settings — define the URL, payload, headers, and which apps are allowed to use it.
- Assign the webhook to an Alert Rule in the relevant Kio App (Staff Safe, Asset Tracker, and others) under the rule's Actions section.
Until a webhook is assigned to at least one Alert Rule, no requests are sent.
Webhook components
| Component | What it is |
|---|---|
| Name | A label for the webhook, used in the history log and when assigning it to Alert Rules |
| URL | The external endpoint that receives the HTTP POST when an Alert Rule is triggered |
| Payload | The body sent with the request, formatted as JSON, XML, or Text. Supports variable injection |
| Headers | Optional HTTP headers to include in the request (for example, authorization tokens) |
| URL Parameters | Optional query string parameters appended to the URL |
| Apps | The Kio Apps whose Alert Rules are allowed to assign this webhook as a notification action |
Variables
Variables inject dynamic values into webhook payloads, headers, and URL parameters. Two types are available:
| Variable type | What it is |
|---|---|
| Built-in | System-provided variables populated from the Alert Rule event that triggered the webhook — including alert name, rule name, urgency, triggering condition, and the entity involved. Available built-in variables depend on which apps are selected. |
| Custom | Variables you create to store account-specific values, such as API keys, team identifiers, or routing codes. Can be Plain (visible) or Secret (masked). |
To reference a variable in a payload or header value, insert it from the variable list. The platform substitutes the value when the webhook request is sent.
History log
Company Settings keeps a log of every webhook request, recording the URL, HTTP status code, and full request and response body for each call. Use it to confirm delivery or diagnose failures.