Skip to main content
API Explorer|API Explorer
Alerting & Response/Alert Channels & Integrations
POSTAlertingSince 1.0SynchronousAuth Required

TestSendAlertNotification

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • channelIdStringRequired

    Channel identifier to send test notification through

Body Fields

  • templateIdStringRequired

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

    Example: tmpl-email-001

Responses

200 OK

On success, this API returns the following response structure.

  • successBoolean

    Whether the test notification was sent successfully

    Example: true

  • errorMessageString

    Error message if the test failed

    Example: authentication failed

  • renderedPreviewString

    Rendered content preview from template

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

Endpoint

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

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

Operation ID

TestSendAlertNotification

Permalink

Request Example

curl -X POST '{host}/api/v1/alerting/channels/{channelId}/test-send' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"templateId":"tmpl-email-001"}'

Response Example

200
{
  "success": true,
  "errorMessage": "authentication failed",
  "renderedPreview": "<h1>Alert: High CPU</h1>"
}

Change History

This API has no change history records yet.

View all change history