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

TestSendAlertNotification

Send a test notification with optional template rendering preview Fixed RI-PT-NI03: unified test send with optional template

POST/api/v1/alerting/channels/{channelId}/test-send

Operation ID

TestSendAlertNotification

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

application/json

Path Parameters

  • channelId
    StringRequired

    Channel identifier to send test notification through

Body Fields

  • templateId
    StringRequired

    Optional template ID for rendering (uses channel default if empty)

    Example: tmpl-email-001

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • success
    Boolean

    Whether the test notification was sent successfully

    Example: true

  • errorMessage
    String

    Error message if the test failed

    Example: authentication failed

  • renderedPreview
    String

    Rendered content preview from template

    Example: <h1>Alert: High CPU</h1>