With alerts, you can tailor how Canary by Pagos notifies you when your metrics change unexpectedly and trigger events. You can elect to receive alerts via email or configured webhooks.

Configuring Alerts

To create a new alert:

1. Navigate to the Triggers page.
2. Click the card for the trigger you want to configure an alert for.
3. Click Alerts to open the Configure Alerts side panel.
4. Under Alert Channels, click the toggles to enable the communication method(s) you want Canary to send alerts by:
   1. Emails - Click the toggle, enter an email address where you’d like to receive email notifications, then click Add Email Address; repeat this step to subscribe more email addresses to these alerts.
   2. Webhooks - Click the toggle, enter a URL endpoint for your generic webhook, then click Add Webhook; repeat this step to add multiple webhook endpoint URLs.
   3. Slack - Click the toggle, then enter both a Slack Incoming Webhooks URL and the name of the Slack channel where you want to receive the notification; click Add Slack Webhook. Repeat this step to add multiple slack webhooks.
5. Click Configure Alerts.

Webhooks

Webhook alerts allow you to integrate any type of Canary event into your existing applications or payment systems. With webhooks, you can act on time sensitive data fluctuations in real time and make decisions quickly about what to do with significant performance changes. Canary currently allows for two types of webhooks: Generic Webhooks and Slack Incoming Webhooks.

Generic Webhooks

For Generic Webhooks, first create a webhook endpoint on your server. Ensure you thoroughly test your endpoint to ensure that it is accessible from external sources, then copy-paste the endpoint URL into the Generic Webhooks field when configuring your Canary alert. When a trigger fires an event notification, you'll receive a webhook containing details of the event in the form of an event object.

Slack Incoming Webhooks

To set up a Slack Incoming Webhooks for your Canary alert:

1. Enable and configure Incoming Webhooks within your Slack app by following the first three steps in Slack’s API documentation.

   1. ❗️

      Note:

      You’ll need the Webhook URL from step 3 in Slack’s guide, along with the name of the Slack channel where you want to receive alerts.

2. When configuring your alert in the Canary service panel, click the toggle for Slack and enter that webhook URL and Slack channel name into the available fields.

Whenever the trigger fires an event alert, you'll receive a notification in the chosen Slack channel.

Editing, Disabling, and Deleting Alerts

You can edit, disable, or delete an alert at any time:

1. Navigate to the Triggers page.
2. Click the trigger you want to alter an alert for.
3. Click Alerts to open the Configure Alerts side panel.
4. Click the toggles to turn on or off Email, Webhook, or Slack alerts. If adding new alert options, fill in the associated fields. If you want to delete the alerts for a trigger, turn all three toggles off.
5. Click Configure Alerts to save the changes.