Canary supports outgoing Webhooks from your Console to an endpoint of your choice. This event-driven approach means you get your alerts in real-time! We support your favourite apps, such as Slack and Microsoft Teams.
In this example, we'll post data to the 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 purposes. You can consume the Webhook by writing a custom endpoint and hosting it on infrastructure under your control.
We also support Flock specific Webhooks — see guide here.
Step 1: Get Your Webhook Endpoint
You will need to have an endpoint to post notifications to. We have used the webhook.site as the endpoint.
Opening the website will reveal a URL to post notifications to (all information is posted in a JSON format).
Copy the URL that is displayed.
Step 2: Log In to the Console
Step 3: Open Global Settings
Click on the Gear and then Global Settings to go to the Global Settings page.
Step 4: Add a New Webhook
- Click on Webhooks.
- Click on the +Add Webhook symbol.
Step 5: Choose 'Generic' Webhook Type
Click on Add Generic.
Step 6: Paste Your Endpoint URL
Paste the URL that you copied in step 1.
Step 7: Save and Test Your Webhook
Once saved, a notification will be posted to the webhook.site URL and alerts will now be posted to this Webhook.
Webhook structure
The structure of the JSON object is as follows: