API referenceOther
Send a test webhook event
Deliver an example event of the given type (marked test: true) to the endpoint now and return the delivery with its attempt.
Authorization
bearer AuthorizationBearer <token>
In: header
Path Parameters
id*string
Match
^whe_[a-z0-9]{8,32}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/webhooks/endpoints/string/test" \ -H "Content-Type: application/json" \ -d '{}'{ "object": "webhook_delivery", "id": "string", "endpoint_id": "string", "event_id": "string", "event_type": "call.completed", "status": "pending", "test": true, "attempts": [ { "n": 1, "at": "2019-08-24T14:15:22Z", "status_code": 0, "latency_ms": 0, "error": "string", "response_snippet": "string" } ], "next_attempt_at": "2019-08-24T14:15:22Z", "request_snippet": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}Rotate a webhook signing secret POST
Issue a new signing secret. The old one keeps signing alongside it for `overlap_s` (default 24 hours), so both verify while you deploy the new one. Returns the new secret once.
Update a webhook endpoint PUT
Change the URL, description or subscribed events, or enable and disable it (re-enabling an automatically disabled endpoint clears its failure count).