Webhooks

List webhook deliveries

Changed on

Retrieve the delivery history for webhooks sent to the account's endpoints — use it to monitor status, debug failures, and verify payloads. Pagination is returned in the X-Pagination-* response headers. Requires the documents:read OAuth scope.

Copy as Markdown Open in ChatGPT Open in Claude

get/v1/accounts/{accountId}/webhooks

Request

  • Base URL
    https://api.assinafy.com.br
  • URL
    https://api.assinafy.com.br/v1/accounts/{accountId}/webhooks
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Path parameters

accountIdstring required

Workspace account ID.

Query parameters

endpoint_idstring

Only deliveries to this webhook endpoint.

eventstring

Filter by event type (e.g. document_ready).

delivered'true' | 'false'

Filter by delivery status: true or false.

frominteger

Unix timestamp — only entries after this time.

tointeger

Unix timestamp — only entries before this time.

pageinteger

Page number.

per-pageinteger

Items per page (default: 20).

Response

Delivery history

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,
      "http_status": 200,
      "response_body": "OK",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ]
}

Changes

  • f231647afa04Revision changes
    • info

      added the new optional query request parameter endpoint_id

    • info

      added the optional property /// to the response with the status