Skip to content
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview

Add an alert destination

A global destination receives every alert of the services that inherit the global routing, and every alert that has no service. The heartbeat goes to none. Stored encrypted.

POST/api/v1/alert-delivery/destinations
Authorization
tse_sessionAPI key · cookierequired
Request body
requiredapplication/json
globalboolean

Omit for true

kindstringrequired
Allowed:webhookslackmsteamsemail
minSeveritystring

Omit for warning: every alert

Allowed:warningcritical
namestringrequired

1 to 64 characters after trimming

urlstringrequired

Absolute http/https URL; https for slack and msteams. For email: one recipient address or a comma-separated list

Responses
201

Created

displaystringrequired

Redacted form: scheme and host only; for email, masked addresses

globalbooleanrequired

Receives the alerts of every service that inherits, and every alert with no service

idinteger<int64>required
kindstringrequired
Allowed:webhookslackmsteamsemail
minSeveritystringrequired

Lowest severity delivered here

Allowed:warningcritical
namestringrequired

The operator's label for the destination

usedByAlertServiceRef[]required

Services that assign this destination

Show properties
Array of AlertServiceRef
serviceIdstringrequired
serviceNamestringrequired
default

Error

codestring

Stable code of the refusal, when the route has codes

detailsstring[]

Additional detail, e.g. per-field validation failures

errorstringrequired

Human-readable error message

Request
curl -X POST 'https://console.example.com/api/v1/alert-delivery/destinations' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "global": true,
  "kind": "webhook",
  "minSeverity": "warning",
  "name": "string",
  "url": "string"
}'
Response
{
  "display": "string",
  "global": true,
  "id": 0,
  "kind": "webhook",
  "minSeverity": "warning",
  "name": "string",
  "usedBy": [
    {
      "serviceId": "string",
      "serviceName": "string"
    }
  ]
}