Test Team Notification Channel

This endpoint sends a simulated message to a specified team notification channel to confirm that it is operational. It is commonly used right after creating, updating, or enabling a channel to ensure it can successfully receive system-generated alerts.

The test does not send real alerts but mimics an actual delivery to validate connectivity, format compatibility, and proper configuration. This helps teams identify setup issues before relying on the channel in live monitoring environments.

Use this feature as a routine step when onboarding new teams, rotating email/webhook endpoints, or verifying channel health after extended inactivity.

Need to view or configure channels before testing? Head over to Get Team Notification Channels or Update Team Notification Channel.

Authorization: Bearer YOUR_TOKEN

Expected Behavior:

On success, the system will send a test message to the specified notification channel and return a confirmation message.
If the request is unauthorized or invalid, the system will respond with an error message.

Path Parameters

id string
The unique ID of the team. Example: 'c03b02ec-244f-4d2c-8f68-3910071ed5c8'

Request Body Parameters

priority positive integer
The priority of the notification channel to be tested. This value can be found in the response of the Get Team Notification Channels endpoint. Example: 1

ResponseThis section is used to view the possible HTTP response codes returned by the API. These codes indicate the status of a request, such as 201 (Created), 401 (Unauthorized), 409 (Conflict), or 422 (Unprocessable Entity).