Sign in
Webhooks

Create webhook endpoint

Changed on

Register a URL to receive the account's webhook events. An account can have 1 endpoint, or up to 3 on paid plans; creating one past the limit returns 403. Each endpoint of a workspace must have a different url (400 otherwise). When signing_enabled is true, a signing secret is generated: read it with Get webhook endpoint signing secret. Requires the webhooks:write OAuth scope.

Copy as Markdown Open in ChatGPT Open in Claude

post/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.

Request body

urlstring uri required

URL that receives the events (http or https).

emailstring email required

Contact email for delivery-failure notices.

eventsstring[] required

Event types to deliver (see GET /v1/webhooks/event-types).

namestring

Label to tell endpoints apart.

is_activeboolean

Whether events are delivered. Defaults to true.

signing_enabledboolean

Sign deliveries with a Standard Webhooks signature. Defaults to false.

Example request

{
  "url": "https://example.com/webhooks/assinafy",
  "email": "ops@example.com",
  "events": [
    "document_ready",
    "signer_signed_document"
  ],
  "name": "ERP",
  "is_active": true,
  "signing_enabled": true
}

Response

The created endpoint

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