Webhook

Test a webhook

Send a test payload to a webhook URL to verify it is working

post/api/v2/webhooks/{id}/test

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/webhooks/{id}/test
  • Auth
    HTTP bearer

Path parameters

idstring uuid required
Example:01a19e6f-89ce-74fd-a33b-906b1d58ce32

Response

Default Response

successboolean
messagestring
response_time_msnumber
status_codenumber
errorstring

Example response

{
  "success": true,
  "message": "Webhook test successful",
  "response_time_ms": 250,
  "status_code": 200,
  "error": "Connection timeout"
}

Changes

No recorded changes to this operation across all 7 revisions of this API.