Webhook Integration

A webhook integration allows you to automatically send information from the Cado platform to another application using a unique URL.

Before You Begin

To add the webhook integration from Cado, you will need to generate a webhook URL from your desired application. Most applications that can receive a post request can be supported.

To view and manage your webhooks settings navigate to Settings > Integrations > Webhooks.

Add or Modify a Webhook

To add a new webhook click the New webhook button at the bottom of the settings page.

You can modify an existing webhook by simply clicking the Edit button. Any new events will be sent to the updated URL or modified payload.

You will then see a form where you must enter all the following:

• Name: The name of the webhook to describe what it is.

• URL: The webhook URL generated by the application you wish to integrate with.

• Events to send: Tick the events you wish to send from Cado to your webhook URL. Cado supports the ability to send the following events:

  • High Severity Alarm
  • Suspicious Severity Event
  • Processing with Alarms
  • Processing Finished
  • Processing Failed
  • Admin Login
  • Audit Event Create
  • Audit Event Update
  • Audit Event Delete
  • Audit Event Login
  • Audit Event Logout
  • Audit Event Download
  • Audit Event Reboot
  • Audit Event Upgrade

• Payload: This is a JSON object that refers to how the webhook URL will receive the data. A webhook must be in the correct format, more information can be found here.

Delete an Existing Webhook

Delete an existing webhook by clicking the associated Delete button. Any new webhooks will not be sent to the entered URL.

Custom Payloads

When entering a webhook you must specify a payload. This is how the webhook URL receives the data from Cado. The payload must be a valid JSON object and have both $Title and $Event as values somewhere in the JSON object. These values tell Cado where to enter the data about the event.

note

When entering the payload refer to the documentation of the application you wish to integration to understand the format the payload must be in. If the payload is not in the correct format for the destination application the event may not be received.

An example of a valid payload:

{
    "title": "$Title",
    "message": "$Event"
}

Slack Integration

You can use webhooks to send notifications to a Slack channel from Cado Response.

1. See the Slack documentation on creating incoming webhooks for Slack. Once you have created an app with incoming webhooks copy the Webhook URL to your clipbard.
2. In the Cado platform under Settings > Integrations > Webhooks select New webhook.
3. Name your webhook and paste the URL from Slack. Then check "High Severity Alarms" under events to send.
4. Cado requires the $Title and $Event values to be specified in the payload and Slack requires a JSON key of text. You can read more about Slack message payloads here and Slack message formatting with Markdown here.

We include an example payload and the Slack message it creates.

{
    "text": "*$Title*\nDetails: $Event"
}

Teams Integration

You can use webhooks to send notifications to a Microsoft Teams channel from the Cado platform.

1. See the Microsoft Teams documentation on creating incoming webhooks for Teams. Once you have created a connector with incoming webhooks copy the Webhook URL to your clipboard.
2. In the Cado platform under Settings > Integrations > Webhooks select New webhook.
3. Name your webhook and paste the URL from Teams. Then check "High Severity Alarms" under events to send.
4. Cado requires the $Title and $Event values to be specified in the payload and Teams requires a JSON key of text. You can read more about Teams message payloads here and Teams message formatting with Markdown here.

We include an example payload and the Teams message it creates (note that the newline character most be preceded by three spaces).

{
    "text": "**$Title**  \nDetails: $Event"
}