Test destination connectivity for Teams, Slack, Email, or generic Webhook.
For teams, POSTs a test JSON body to webhook_url (HTTP webhook / workflow).
For slack, sends a test message via the Slack Web API using the stored bot token
and channel_id—not an outbound POST to a caller-supplied URL. No destination row is
required for that channel; the test only needs a valid Slack integration and channel id.
For email, sends a short SMTP test message to the listed addresses.
For webhook, POSTs a sample JSON payload to the supplied webhook_url with optional
custom headers.
- request (DestinationTestRequest): Required. The payload that includes:
- integration_type (IntegrationType):
teams,slack,email, orwebhook - webhook_url (HttpUrl): Required for
teamsandwebhook. Target URL for the test POST. - integration_id (UUID): Required for
slack. Slack integration identifier. - channel_id (str): Required for
slack. Slack channel ID. - emails (List[str]): Required for
email. Recipient addresses. - headers (dict[str, str]): Optional for
webhook. Custom HTTP headers to attach.
- integration_type (IntegrationType):
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Tests connectivity for a Microsoft Teams, Slack, email, or generic webhook destination. For Teams and webhooks it posts a test JSON body to the webhook_url; for Slack it sends a test message through the Slack Web API using the stored integration; for email it sends a short test message to the listed addresses.
When to use it
Use it to confirm alerts will arrive before you create a destination or attach it to a policy.
Required parameters
- Request body: an object with
integration_type(teams,slack,email, orwebhook) and the fields that type needs:webhook_urlforteamsandwebhook,integration_idandchannel_idforslack, oremailsforemail.headersis optional forwebhook.
Response
A successful call returns 204 No Content with an empty body.
Related: Create a destination, Update a destination, List integrations
204Successful Response
400Bad Request
404Not Found
422Unprocessable Entity
500Internal Server Error