Skip to main content
POST
/
api
/
v1
/
webhooks
/
{webhook_id}
/
test
Send a test payload to the webhook URL
curl --request POST \
  --url https://api.example.com/api/v1/webhooks/{webhook_id}/test
{
  "success": true,
  "status_code": 123,
  "response_body": "<string>",
  "error": "<string>"
}

Path Parameters

​
webhook_id
string
required

Response

Successful Response

Response for the test webhook endpoint.

​
success
boolean
required
​
status_code
integer | null
required
​
response_body
string | null
required
​
error
string | null