Sign in

Send a test webhook

Sends a test webhook to the subscription's URL to verify connectivity and configuration.

post/api/webhookSubscriptions.test

Request body

workspace_idstring required

The ID of the workspace

idstring required

The ID of the subscription to test

event_typestring

Optional event type to use for the test webhook payload

Example request

{
  "workspace_id": "ws_1234567890",
  "id": "whsub_a1b2c3d4e5f6",
  "event_type": "contact.created"
}

Response

Test webhook sent (check response for success/failure)

successboolean

Whether the test webhook was delivered successfully

status_codeinteger

HTTP status code returned by the webhook endpoint

response_bodystring

Response body from the webhook endpoint

errorstring nullable

Error message if the test failed

Example response

{
  "success": true,
  "status_code": 200,
  "response_body": "{\"received\": true}"
}

Changes

Changed in 2 of the 25 revisions of this API.2