Test notification method

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 body

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

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.

{"stackTrail":"paths:/notification_methods/test:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

No recorded changes to this endpoint across all 1 revision of this API.