OverviewAPI ReferenceResources
Webhooks

Test a webhook

Sends a signed webhook.test event to one of your webhooks and returns your server's status code. delivered is true whenever your server answered, whatever the status, so check statusCode. If your server doesn't answer within 10 seconds, the response is 200 with delivered: false.


POST
/api/v1/webhooks/test

Authorization

AuthorizationRequiredBearer <token>

A Convo API key: convo_ followed by 32 hex characters. Create it in the Convo desktop app under Settings → Convo API.

In: header

Request Body

application/jsonRequired
webhookIdRequiredstring

ID of the webhook to test

curl -X POST "https://www.itsconvo.com/api/v1/webhooks/test" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "webhookId": "8d3f6a52-1c4e-4b7a-9e2d-5f0b8c1a7e34"
  }'

Test result

Was this page helpful?