Notifications

Test notification method

Changed on

Validate that the provided parameters allow sending a test notification.

Email: value=recipient email address. Slack: Incoming Webhook URL. Telegram: value=bot token, second_value=chat_id. Discord: Webhook URL. Webhook: sends a JSON payload to the provided URL.

post/notification_methods/test

Request

Request body

type'email' | 'slack' | 'telegram' | 'webhook' | 'discord' required
namestring nullable

Optional label telling this channel apart from others of the same type (e.g. the Slack channel the webhook posts to). On update, omit it to keep the current name; send null or an empty string to clear it.

valuestring required

Primary value (e.g., webhook URL, bot token, or email address).

second_valuestring nullable

Secondary value when required by the method (e.g., Telegram chat_id).

extra_emailsstring[] nullable

Up to 4 additional email recipients (delivered as BCC). Only allowed when type=email. Total recipients (value + extra_emails) must be ≤ 5.

Example request

{
  "type": "email",
  "value": "alerts@example.com"
}

Response

Test notification sent successfully.

unknown required

Changes