Configure your Alerting Outputs

Learn how to configure or update the destinations for receiving notifications.

Description

Sentry is an automated notification system that delivers real-time alerts through various outputs. To effectively send notifications, the system requires information about the specific URL or device to which these notifications should be directed.

Currently, Sentry supports two types of outputs:

  • Webhook: Enables receiving notifications on a server. This allows the account to process these notifications using custom logic or to redistribute them as needed.

  • Telegram: Allows direct receipt of push notification messages on a device, eliminating the need for a server setup.

Scope: Outputs are defined at the account level, with one configuration per account. By default, no outputs are configured. Instructions below guide you on how to set up or update these outputs.

Note: Both outputs can be utilized concurrently, offering flexibility in how you receive alerts.

Endpoint

PUT https://sentry.aleno.ai/account

Query parameters

No query parameters.

Payload

NamerequiredTypeDescription

webhookUrl

optional

String or Null

Target webhook URL on which you want to receive notifications. If set to null, the system won't send you notifications

telegramChannelId

optional

String or Null

Telegram channel ID on which you want to receive notifications. If set to null, the system won't send you notifications. See the docs to configure a channel.

Id must start with '-'.

CURL example

curl -X PUT \
  https://sentry.aleno.ai/account \
  -H 'accept: application/json' \
  -H 'Authorization: YOUR_API_KEY' \
  -d '{"webhookUrl": "YOUR_WEBHOOK_URL"}'

Result

If the output has been successfully updated, it returns an AlertOutputs object with the new configurations associated with your account:

{
    "data": {
        "alertOutputs": {
            "webhookUrl": "YOUR_WEBHOOK_URL"
        },
        "message": "Your outputs have been successfully updated"
    }
}

Last updated