Skip to main content
POST
Test a destination before saving it

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

x-tenant-id
string
required

The organization ID the request is scoped to.

Body

application/json

Request body to create a Slack alert destination.

integration_id
string
required

Opaque identifier of the alert integration this destination sends through. Its integration_type must match the destination's. Set when the destination is created and immutable afterward.

integration_type
string
required

The kind of destination, matching the integration_type of its alert integration. Determines which settings the destination carries. Set when the destination is created and immutable afterward.

Allowed value: "slack"
channel
string
required

Name of the Slack channel alerts are posted to, without the leading #. The SELECT app must be added to a private channel before alerts can be delivered to it.

Minimum string length: 1

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.