Webhooks

List webhook endpoints

Changed on

List the account's webhook endpoints, oldest first. Requires the account:read OAuth scope.

Copy as Markdown Open in ChatGPT Open in Claude

get/v1/accounts/{accountId}/webhooks/endpoints

Request

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

Path parameters

accountIdstring required

Workspace account ID.

Response

The endpoints

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": [
    {
      "id": "65f1c2a9b3e4d5f60718293a4b5c6d7e",
      "name": "ERP",
      "url": "https://example.com/webhooks/assinafy",
      "email": "ops@example.com",
      "events": [
        "document_ready",
        "signer_signed_document"
      ],
      "is_active": true,
      "signing_enabled": true,
      "created_at": "2026-10-01T12:00:00Z",
      "updated_at": "2026-10-01T12:00:00Z"
    }
  ]
}

Changes