Webhook Payloads

document_contract_amended

A signed amendment, renewal or termination document updated the contract terms of the parent document; changes lists every field that moved as {from, to}, null when the instrument moves none (the parent is then left as it was and no document_contract_updated follows). Sent seconds after the amendment document is certificated (a job on its document_ready event) or by the hourly contract run that catches up, both with subject Account; or, for a document already signed when linked, by the user who linked it (subject User, user_name in the payload; see the by_user example). Subject: Account or User · Object: Document (the parent) · Payload: document_id (the amendment document), relation_type (amendment, renewal or termination), number, changes, end_date (the parent's end date after the change), changed (the names of the parent's fields that moved, as document_contract_updated lists them; [] when none did).

postWebhookdocument_contract_amended

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.