Webhooks

List webhook event types

List all available event types that can be subscribed to via webhooks. Requires the documents:read OAuth scope.

Copy as Markdown Open in ChatGPT Open in Claude

get/v1/webhooks/event-types

Request

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

Response

Event types

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": [
    {
      "id": "document_ready",
      "description": "Triggered when the last Signer of the assignment signs the Document."
    }
  ]
}

Changes

No recorded changes to this operation across all 14 revisions of this API.