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 List
2. Click the trigger you want to configure an alert for.
3. Next to Alerts, click the name of the Trigger to open the Alert Details panel.
4. To enable alerts, click the Status toggle.
5. Under Alerting Options, click the toggles to enable the communication method(s) you want Canary to send alerts by:
   1. Emails - Click the toggle, then enter an email address where you’d like to receive email notifications, then click Add
   2. Generic Webhooks - Click the toggle, then enter a URL endpoint for your webhook and click Add
   3. Slack Incoming Webhooks - Click the toggle, then enter both a Slack URL endpoint for the webhook and the name of the Slack channel where you want to receive the notification; click Add

After you finish configuring your alert, click the save icon.

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 Incoming Webhooks 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 List
2. Click the trigger you want to alter an alert for.
3. Next to Alerts, click the name of the Trigger to open the Alert Details panel.
4. Click the edit icon.
   1. To edit, alter the desired fields.
   2. To disable, click the Status toggle so it reads Alert is disabled. You'll stop receiving notifications for the related trigger until you enable it again.
   3. To delete, click the trash icon.
5. Click the save icon.