Webhook Payloads

document_contract_updated

A user created or changed the contract terms of the document. Read them with GET /v1/accounts/{accountId}/documents/{documentId}/contract. Also sent by the hourly run when it hands the contract of an owner who left the workspace to another owner. Also sent whenever the terms change by other means (see the by_system example: subject Account, no user_name) — right after document_contract_amended, document_contract_renewed, document_contract_expired or document_contract_terminated — with the subject of that event (Account on the hourly or queued run, without user_name). Subject: User, or Account · Object: Document · Payload: user_name (User subject only), end_date (the end date after the change; null when none), changed (the fields of the contract resource that changed, such as ["value", "end_date", "term"]; for terms just created, every field that differs from a contract with no terms).

postWebhookdocument_contract_updated

Headers

User-Agentstring required

Always Assinafy-Webhooks/1.0.

webhook-idstring required

Message ID: the same on every attempt of this event to this endpoint. Use it to deduplicate retries.

webhook-timestampstring required

Unix timestamp (seconds) of this attempt.

webhook-signaturestring

Sent only when signing is enabled on the endpoint: v1,<base64 HMAC-SHA256>. See Verifying signatures.

Payload

idinteger required

ID of the activity that produced the event.

eventstring required

Event type. See List webhook event types.

messagestring nullable

Reserved; currently always null.

payloadobject nullable

Event-specific parameters; keys vary per event.

created_atinteger required

When the event was recorded (Unix timestamp, seconds).

subjectobject required

Who performed the action: a User, Signer or Account, plus a type property naming it.

objectobject required

What the action was performed on: a Document, Signer or Template with its relations expanded, plus a type property naming it.

account_idstring required

ID of the account that owns the event.

Example payload

{
  "id": 184467,
  "event": "signer_viewed_document",
  "origin": {
    "ip": "203.0.113.7",
    "user-agent": "Mozilla/5.0"
  },
  "created_at": 1790000000,
  "account_id": "65f1c2a9b3e4d5f6"
}

Response

Any 2xx response acknowledges the delivery. Any other status, a connection error or a timeout counts as a failed attempt.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.