Notifications

With notifications, you can tailor how Canary by Pagos alerts you when your metrics change unexpectedly and trigger events. By default, notifications appear only in the service panel UI (web), but you can elect to receive them via email or configured webhooks.

Notification List

The Notification List provides you with an inbox-style way of browsing all your configured notifications. To access your Notifications List:

  1. Open the Canary Service Panel
  2. Click Notifications in the navigation bar.

From this screen, you can add, edit, or delete notifications. To edit a notification, click its row in the list; this opens the side edit panel.

Configuring Notifications

To create a new notification, navigate to the Notification List, then click + Add and configure the following settings:

  • Source - Select one of your triggers as a source for the notification from the drop-down menu
  • Type - This field auto-populates based on the selected Source; user-configured triggers are always Trigger notifications
  • Name - The notification title that appears in notification messages or webhook callbacks; it auto-populates to match the name of the trigger used as the Source
  • Click the toggles to enable the communication method(s) you want Canary to send the notification by:
    • Emails - Enter an email address where you’d like to receive email notifications, then click Add
    • Generic Webhooks - Enter a URL endpoint for your webhook, then click Add
    • 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 notification, click Save.

Webhooks

Webhook notifications 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 notification. 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 notification:

  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 notification 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 notification, you'll receive an alert in the chosen Slack channel.

Disabling and Deleting Notifications

You can disable or delete a notification at any time.

By disabling a notification, you'll stop receiving alerts for the related trigger until you enable it again. To do so, locate the notification in the Notification List, then ensure all of the checkboxes for each destination option (Email, Generic Webhooks, and Slack Incoming Webhooks) are unchecked.

To completely delete a notification, click the notification row in the Notification List, then click Remove.