Send a test webhook to verify endpoint connectivity
X-Api-Key<token>
Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.
In: header
Path Parameters
id*string
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/test" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "webhookEndpointId": "string", "eventType": "document.finalized", "payload": {}, "status": "delivered", "statusCode": 200, "responseBody": "string", "attemptNumber": 1, "maxAttempts": 5, "nextRetryAt": "2019-08-24T14:15:22Z", "deliveredAt": "2019-08-24T14:15:22Z", "errorMessage": "string", "createdAt": "2019-08-24T14:15:22Z"}