Sign in
Webhooks

Update webhook endpoint

Changed on

Change a webhook endpoint. Only the fields sent are updated; url cannot be one another endpoint of the workspace already uses (400). Setting signing_enabled to true generates a secret if the endpoint has none and keeps the current one otherwise; setting it to false discards the secret. Requires the webhooks:write OAuth scope.

Copy as Markdown Open in ChatGPT Open in Claude

put/v1/accounts/{accountId}/webhooks/endpoints/{endpointId}

Request

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

Path parameters

accountIdstring required

Workspace account ID.

endpointIdstring required

The webhook endpoint ID.

Request body

urlstring uri
emailstring email
eventsstring[]
namestring
is_activeboolean
signing_enabledboolean

Example request

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

Response

The updated 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