ReferenceAPI referenceWebhooks
Send a test event to a webhook endpoint
Send a test event to a webhook endpoint: CustomDomain™ API reference in the webhooks group. Covers parameters, request body, responses and error codes.
Signs and sends one webhook.test event to this endpoint now, whatever events it subscribes to, and answers with the delivery: whether it arrived, the receiver's status code and, when it did not, the error. It tries once, with no retries, and the attempt is added to GET /webhook-deliveries. A delegated agent token needs app:write.
AuthorizationBearer <token>
Short-lived widget JWT minted server-side via POST /v1/tokens. Scoped to one application (and optionally one domain).
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/webhooks/string:test"{ "id": "string", "endpoint_id": "string", "application_id": "string", "url": "http://example.com", "event_id": "string", "event_type": "string", "domain": "string", "attempts": 0, "status_code": 0, "delivered": true, "error": "string", "created_at": "2019-08-24T14:15:22Z"}{ "code": "account_not_verifiable", "title": "string", "details": "string", "challenge": { "value": "string", "bits": 1, "expires_at": "2019-08-24T14:15:22Z" }}{ "code": "account_not_verifiable", "title": "string", "details": "string", "challenge": { "value": "string", "bits": 1, "expires_at": "2019-08-24T14:15:22Z" }}{ "code": "account_not_verifiable", "title": "string", "details": "string", "challenge": { "value": "string", "bits": 1, "expires_at": "2019-08-24T14:15:22Z" }}