HomeGuidesAPI ReferenceRelease notes
Log In
API Reference

Test Webhook

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, or webhook
    • webhook_url (HttpUrl): Required for teams and webhook. 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.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

POST /v1/destinations/test body for Teams: POST JSON to a workflow or incoming webhook URL.

const
enum
required
Allowed:
uri
required
length between 1 and 2083
Responses
204

Successful Response

400

Bad Request

404

Not Found

422

Unprocessable Entity

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here!