Version 2.4.7.20261116085428 · latest

Alert webhooks message-webhooks

DingTalk, Feishu, WeCom, Telegram and generic JSON alert outputs; several can be configured, and addresses and secrets show only the last 4 characters.

Pick an endpoint to see its example call on the right.

MessagesAuthentication: Admin only6 endpoints

Authentication

Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.

X-API-Key

Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).

Conventions

Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.

Times are RFC 3339 (UTC); amounts are in cents.

Writes return 200/201/204 on success; duplicates of a unique key return 409.

GET/api/v2/message-webhooksList alert webhooks

Authentication: Admin only

Query parameters

FieldTypeDescription
pageinteger Page number, starting from 1
Default 1
page_sizeinteger Items per page
Default 20
POST/api/v2/message-webhooksCreate alert webhook

Authentication: Admin only

Request body application/json

FieldTypeDescription
chat_idstring Telegram chat (numeric id or @channel name).
created_atRequiredstring Created at
enabledboolean Whether it is enabled; disabled ones are skipped. Enabled by default.
eventsstring[] Event types to receive: alert (platform alerts) and ticket (tickets). Omitted on create means all; omitted on update keeps the current value; an empty array is rejected with 422.
idRequiredinteger Record ID
kindRequiredstring Kind: dingtalk, feishu, wecom, telegram or generic JSON.
Values ["dingtalk","feishu","wecom","telegram","generic"]
last4string Last 4 characters of the address (the token for Telegram), for recognition only.
nameRequiredstring Name, unique across all webhooks.
secretstring Bot token for Telegram (required); signing secret for the others (optional). Write-only, never echoed.
updated_atRequiredstring Updated at
urlstring Bot URL (https, public; required for DingTalk, Feishu, WeCom and generic; unused for Telegram). Write-only, never echoed.
POST/api/v2/message-webhooks/testTest unsaved alert webhook

Authentication: Admin only

Request body application/json

FieldTypeDescription
chat_idstring Telegram chat (numeric id or @channel name).
idinteger Record ID
kindRequiredstring Kind: dingtalk, feishu, wecom, telegram or generic JSON.
Values ["dingtalk","feishu","wecom","telegram","generic"]
secretstring Bot token for Telegram (required); signing secret for the others (optional). Write-only, never echoed.
urlstring Bot URL (https, public; required for DingTalk, Feishu, WeCom and generic; unused for Telegram). Write-only, never echoed.
PUT/api/v2/message-webhooks/{id}Update alert webhook

Authentication: Admin only

Request body application/json

FieldTypeDescription
chat_idstring Telegram chat (numeric id or @channel name).
created_atRequiredstring Created at
enabledboolean Whether it is enabled; disabled ones are skipped. Enabled by default.
eventsstring[] Event types to receive: alert (platform alerts) and ticket (tickets). Omitted on create means all; omitted on update keeps the current value; an empty array is rejected with 422.
idRequiredinteger Record ID
kindRequiredstring Kind: dingtalk, feishu, wecom, telegram or generic JSON.
Values ["dingtalk","feishu","wecom","telegram","generic"]
last4string Last 4 characters of the address (the token for Telegram), for recognition only.
nameRequiredstring Name, unique across all webhooks.
secretstring Bot token for Telegram (required); signing secret for the others (optional). Write-only, never echoed.
updated_atRequiredstring Updated at
urlstring Bot URL (https, public; required for DingTalk, Feishu, WeCom and generic; unused for Telegram). Write-only, never echoed.
POST/api/v2/message-webhooks/{id}/testTest saved alert webhook

Authentication: Admin only

Alert webhooks object

FieldTypeDescription
chat_idstring Telegram chat (numeric id or @channel name).
created_atstring Created at
read-only
enabledboolean Whether it is enabled; disabled ones are skipped. Enabled by default.
errorstring Error message when the test failed.
eventsstring[] Event types to receive: alert (platform alerts) and ticket (tickets). Omitted on create means all; omitted on update keeps the current value; an empty array is rejected with 422.
idinteger Record ID
read-only
kindstring Kind: dingtalk, feishu, wecom, telegram or generic JSON.
Values ["dingtalk","feishu","wecom","telegram","generic"]
last4string Last 4 characters of the address (the token for Telegram), for recognition only.
read-only
namestring Name, unique across all webhooks.
okboolean Whether the test send succeeded.
secretstring Bot token for Telegram (required); signing secret for the others (optional). Write-only, never echoed.
updated_atstring Updated at
read-only
urlstring Bot URL (https, public; required for DingTalk, Feishu, WeCom and generic; unused for Telegram). Write-only, never echoed.

Responses and errors

Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "code": "validation_failed",
  "detail": "Invalid request parameters",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name is required"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command