Skip to content
Vocapable Developers

Send one signed sample event to the endpoint, synchronously

POST
/v1/webhook-endpoint/test
curl --request POST \
  --url https://api.vocapable.com/v1/webhook-endpoint/test \
  --header 'Authorization: Bearer <token>'

Prove the receiver end to end before any real call depends on it.

The sample rides the exact production mechanics - same envelope keys, same compact key-ordered serialization, same Vocapable-Signature scheme signed with the same secrets (both, during a rotation overlap), same 10-second success rule - so a receiver that verifies this ping verifies real traffic. data.test: true is the marker; nothing durable is written and no outbox row is minted.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WebhookTestResult

What one signed sample POST to the tenant’s endpoint answered.

object
delivered
required
Delivered
boolean
status_code
required
Any of:
integer
event_type
required
Event Type
string
detail
required
Detail
string
Examplegenerated
{
  "delivered": true,
  "status_code": 1,
  "event_type": "example",
  "detail": "example"
}