Skip to main content

Create a webhook

A Webhook is a reusable notification action for Alert Rules. Create it once in Company Settings, then assign it to Alert Rules in individual Kio Apps. The webhook request is sent each time an alert is triggered by an assigned Alert Rule.

Before you begin

  • Administrator role in Company Settings
  • The external system URL that will receive the webhook requests
  • Any authentication credentials the external system requires (for example, an API key to include as a header)
  • At least one Kio App with Alert Rules active on the account

Steps

  1. Open Company Settings from the Kontakt.io Launchpad.
  2. In the navigation menu, select Webhooks.
  3. Select Add New Webhook.
  4. Enter a Name for the webhook.
  5. Enter the URL for the external endpoint.
  6. Under Apps, select the Kio Apps whose Alert Rules will be allowed to assign this webhook as a notification action.
  7. In the Payload field, enter the body in JSON, XML, or Text format. To include alert data or a custom value, enter $ where you want the value to appear and select a variable from the list. The built-in variables offered depend on the Apps selected in step 6.
  8. To add HTTP headers, select Add Header and enter the key and value. Use variables for sensitive values such as authorization tokens.
  9. To add URL parameters, select Add Parameter and enter the key and value.
  10. Select Save.

The webhook appears in the Webhooks list.

What happens next

No requests are sent until the webhook is assigned to an Alert Rule. To assign it:

  1. Open the relevant Kio App from the Kontakt.io Launchpad.
  2. Go to Alert Rules.
  3. Edit an existing rule or create a new one.
  4. In the Actions section, select Webhook and choose this webhook.
  5. Save the Alert Rule.

Once assigned, the webhook request is sent each time that an alert is triggered by the Alert Rule.