Description: Canary supports outgoing webhooks from the console to an endpoint of your choice. This event-driven approach means you get your alerts as they occur, instead of waiting to poll the server. We support your favourite apps such as Slack and Microsoft Teams. We also have a Generic option that can be used just as well.

Follow the steps below to enable and set up a Generic Webhook on your Canary console. In this example, we’ll post data to webhook.site, a public tool for assisting in webhook development. It’s useful to see what data is posted in the webhook, but we don’t recommend using it for production purpose. You can consume the webhook by writing a custom endpoint and hosting it on infrastructure under your control.

Step 1:

Login to your console.

Step 2:

Click on "Setup" to go to the Canary settings page.

Step 3:

Click on "Webhooks" from the menu.

Step 4:

Turn on "Webhook Incident Reporting".

Step 5:

Once turned on you can click on "Generic".

...and then click on "Add Generic Webhook":

Step 6:

You will need to have an endpoint to post notifications to. We have used webhook.site as the endpoint.

Opening the website will reveal a URL to post notifications to (All information is posted in a json format).

Step 7:

Copy the URL that is given.

Step 8:

Paste the URL into the Generic Webhooks on your console.

Step 9:

Click "Save" to save the changes.

Step 10:

Once saved a notification will be posted to the RequestBin URL that was created.

All alerts will now be posted to the Webhook.site URL.

Webhook structure

The structure of the JSON object is as follows:

Canary Alert

Canarytoken