Skip to content
You're viewing documentation for v2026.11.5-beta. It may be out of date.Go to latest
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview

Set heartbeat destination

Omitted keeps the stored value, an empty string clears it. Stored encrypted. Responds with the same redacted shape as the GET, so the console can update without a second request.

PUT/api/v1/alert-delivery
Authorization
tse_sessionAPI key · cookierequired
Request body
requiredapplication/json
watchdogWebhookUrlstring

Absolute http/https URL. Omit to keep; empty string clears

Responses
200

OK

destinationsAlertDestinationResponse[]required
Show properties
Array of AlertDestinationResponse
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
watchdogRedactedURLrequired
Show properties
configuredbooleanrequired
displaystringrequired

Redacted form: scheme and host only

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 PUT 'https://console.example.com/api/v1/alert-delivery' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "watchdogWebhookUrl": "string"
}'
Response
{
  "destinations": [
    {
      "display": "string",
      "global": true,
      "id": 0,
      "kind": "webhook",
      "minSeverity": "warning",
      "name": "string",
      "usedBy": [
        {
          "serviceId": "string",
          "serviceName": "string"
        }
      ]
    }
  ],
  "watchdog": {
    "configured": true,
    "display": "string"
  }
}