Skip to main content
ZStack
Alerting & Response/Alert Channels & Integrations

TestAlertChannel

Test a notification channel by sending a test message

POST/api/v1/alerting/channels/{uuid}/test

Operation ID

TestAlertChannel

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • uuid
    StringRequired

    UUID of the channel to test

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • success
    Boolean

    Whether the test message was delivered successfully

    Example: true

  • message
    String

    Result message or error description

    Example: Test message delivered successfully

  • durationMs
    String

    Time taken for the test in milliseconds

    Example: 250