ASassinafy
Webhooks

Send a test delivery

Changed on

Sends the endpoint one webhook_test event now, signed and sent like any delivery, and returns the entry of that attempt (kind: manual, also listed in the delivery history). It goes to this endpoint only, whatever events it subscribes to, and also while the endpoint is paused or inactive; it neither lifts a pause nor counts toward one. The endpoint has 10 seconds to answer. Its payload and origin are null; the endpoint object carries its id, name, url, events and status, never its secret. No endpoint can subscribe to webhook_test, and it is not listed in GET /webhooks/event-types. Its payload and origin are null; the endpoint object carries its id, name, url, events and status, never its secret. No endpoint can subscribe to webhook_test, and it is not listed in GET /webhooks/event-types. The event names the endpoint as its subject and object and carries nothing about the workspace beyond account_id: no billing and no members. Up to 10 tests per user every 10 minutes. Requires the webhooks:write OAuth scope.

Copy as Markdown Open in ChatGPT Open in Claude

post/v1/accounts/{accountId}/webhooks/endpoints/{endpointId}/test

Request

Path parameters

accountIdstring required

Workspace account ID.

endpointIdstring required

The webhook endpoint ID.

Response

The entry of the test delivery

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": {
    "resource": "activity_dispatching_history",
    "id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "event": "document_ready",
    "activity_id": 456,
    "endpoint_id": "65f1c2a9b3e4d5f60718293a4b5c6d7e",
    "endpoint": "https://example.com/webhook",
    "delivered": true,
    "webhook_id": "9f86d081884c7d659a2feaa0c55ad015",
    "attempt": 2,
    "kind": "scheduled",
    "will_retry": true,
    "duration_ms": 184,
    "http_status": 200,
    "response_body": "OK",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

Changes