OPopenobserve
Alerts

List prebuilt alert destination templates

Retrieves a list of prebuilt alert destination templates that can be used as starting points for creating alert destinations. These templates include popular services like Slack, Microsoft Teams, PagerDuty, Discord, and generic webhooks with preconfigured settings. Users can customize these templates with their own URLs and credentials to quickly set up alert notifications.

get/api/{org_id}/alerts/destinations/prebuilt

Request

Path parameters

org_idstring required

Organization name

Response

Success

auto_investigate'off' | 'critical'
buttonsboolean nullable

Acknowledge, Mute and Investigate on each message; default true.

channel_idstring nullable
channel_namestring nullable
installation_idstring nullable
oncall_room_confirmedboolean nullable

Required true when an on-call team pages into this channel through a Slack webhook.

previous_webhookobject nullable

The webhook a switch replaced, kept so it can be switched back; never sent to.

refire_reuse_minutesinteger nullable

0 to 240; default 30.

shared_channel_confirmedboolean nullable

Required true when the channel is shared with another company.

aws_regionstring nullable

AWS region for SNS destinations. Required when type is sns.

destination_type_namestring nullable

Specific destination type identifier (e.g., "openobserve", "splunk", "elasticsearch").

emailsstring[]

Email recipients for Email destinations. Required when type is email.

headersobject nullable

Optional HTTP headers for webhook requests; values read back blank without PUT.

metadataobject

Optional key-value metadata; without PUT, values outside the known plain keys read blank.

method'post' | 'put' | 'get'
namestring

Unique name for this destination. Must be unique within the organization.

skip_tls_verifyboolean

Whether to skip TLS certificate verification for HTTP destinations.

sns_topic_arnstring nullable

SNS topic ARN for SNS destinations. Required when type is sns.

templatestring nullable

REQUIRED for alert destinations. Name of the template to use for formatting alert messages. Use "Default" for the built-in default template. Without a template, the destination becomes a pipeline destination and cannot be used with alerts.

type'http' | 'email' | 'sns' | 'slack_app'
urlstring

Webhook URL, required for http; without PUT, its origin, or empty for a keyed host.

Example response

[
  {
    "channel_id": "C0FAKE00001",
    "name": "my_alert_webhook",
    "template": "Default",
    "url": "https://example.com/webhook"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.