Version 2.1.1792967583 · latest Download OpenAPI Markdown

Alert webhooks

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

message-webhooksMessagesAuthentication: Admin only6 endpoints

List alert webhooks

GET/api/v2/message-webhooks

Authentication: Admin only

Query parameters

Field	Type	Required	Description
page	integer	—	Page number, starting from 1 Default `1`
page_size	integer	—	Items per page Default `20`

Create alert webhook

POST/api/v2/message-webhooks

Authentication: Admin only

Request body application/json

Field	Type	Required	Description
chat_id	string	—	Telegram chat (numeric id or @channel name).
created_at	string	Required	Created at
enabled	boolean	—	Whether it is enabled; disabled ones are skipped. Enabled by default.
id	integer	Required	Record ID
kind	string	Required	Kind: dingtalk, feishu, wecom, telegram or generic JSON. Values `["dingtalk","feishu","wecom","telegram","generic"]`
last4	string	—	Last 4 characters of the address (the token for Telegram), for recognition only.
name	string	Required	Name, unique across all webhooks.
secret	string	—	Bot token for Telegram (required); signing secret for the others (optional). Write-only, never echoed.
updated_at	string	Required	Updated at
url	string	—	Bot URL (https, public; required for DingTalk, Feishu, WeCom and generic; unused for Telegram). Write-only, never echoed.

Test unsaved alert webhook

POST/api/v2/message-webhooks/test

Authentication: Admin only

Request body application/json

Field	Type	Required	Description
chat_id	string	—	Telegram chat (numeric id or @channel name).
id	integer	—	Record ID
kind	string	Required	Kind: dingtalk, feishu, wecom, telegram or generic JSON. Values `["dingtalk","feishu","wecom","telegram","generic"]`
secret	string	—	Bot token for Telegram (required); signing secret for the others (optional). Write-only, never echoed.
url	string	—	Bot URL (https, public; required for DingTalk, Feishu, WeCom and generic; unused for Telegram). Write-only, never echoed.

Update alert webhook

PUT/api/v2/message-webhooks/{id}

Authentication: Admin only

Request body application/json

Field	Type	Required	Description
chat_id	string	—	Telegram chat (numeric id or @channel name).
created_at	string	Required	Created at
enabled	boolean	—	Whether it is enabled; disabled ones are skipped. Enabled by default.
id	integer	Required	Record ID
kind	string	Required	Kind: dingtalk, feishu, wecom, telegram or generic JSON. Values `["dingtalk","feishu","wecom","telegram","generic"]`
last4	string	—	Last 4 characters of the address (the token for Telegram), for recognition only.
name	string	Required	Name, unique across all webhooks.
secret	string	—	Bot token for Telegram (required); signing secret for the others (optional). Write-only, never echoed.
updated_at	string	Required	Updated at
url	string	—	Bot URL (https, public; required for DingTalk, Feishu, WeCom and generic; unused for Telegram). Write-only, never echoed.

Delete alert webhook

DELETE/api/v2/message-webhooks/{id}

Authentication: Admin only

Test saved alert webhook

POST/api/v2/message-webhooks/{id}/test

Authentication: Admin only

Alert webhooks object

Field	Type	Required	Description
chat_id	string	—	Telegram chat (numeric id or @channel name).
created_at	string	—	Created at read-only
enabled	boolean	—	Whether it is enabled; disabled ones are skipped. Enabled by default.
error	string	—	Error message when the test failed.
id	integer	—	Record ID read-only
kind	string	—	Kind: dingtalk, feishu, wecom, telegram or generic JSON. Values `["dingtalk","feishu","wecom","telegram","generic"]`
last4	string	—	Last 4 characters of the address (the token for Telegram), for recognition only. read-only
name	string	—	Name, unique across all webhooks.
ok	boolean	—	Whether the test send succeeded.
secret	string	—	Bot token for Telegram (required); signing secret for the others (optional). Write-only, never echoed.
updated_at	string	—	Updated at read-only
url	string	—	Bot URL (https, public; required for DingTalk, Feishu, WeCom and generic; unused for Telegram). Write-only, never echoed.