Skip to main content
POST
Test a destination

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

x-tenant-id
string
required

The organization ID the request is scoped to.

Path Parameters

destination_id
string
required

Response

Successful Response

The outcome of sending a test message to an alert destination.

success
boolean
required
read-only

Whether the test message was delivered to the destination.

error_message
string | null

Why delivery failed, in words suitable for showing to the person who configured the destination. Null when success is true.