Skip to main content
POST
Send a test webhook

Authorizations

Authorization
string
header
required

API token for authentication

Body

application/json
workspace_id
string
required

The ID of the workspace

Example:

"ws_1234567890"

id
string
required

The ID of the subscription to test

Example:

"whsub_a1b2c3d4e5f6"

event_type
string

Optional event type to use for the test webhook payload

Example:

"contact.created"

Response

Test webhook sent (check response for success/failure)

success
boolean

Whether the test webhook was delivered successfully

Example:

true

status_code
integer

HTTP status code returned by the webhook endpoint

Example:

200

response_body
string

Response body from the webhook endpoint

Example:

"{\"received\": true}"

error
string | null

Error message if the test failed

Example:

null