Webhook Payloads

document_contract_amendment_updated

A user linked the document to a contract as its amendment, renewal or termination, changed the terms the link carries, or unlinked it (parent_document_id null, see the unlinked example). Sent for every change to the link (a retry that changes nothing is not sent), a signed instrument included: a signed instrument blocked from applying can still have its recorded delta corrected, and this is the record of who did. Subject: User · Object: Document (the instrument) · Payload: user_name, parent_document_id, relation_type, terms (the delta as it now stands; null after an unlink), changed (which of parent_document_id, relation_type and terms moved: all three on a first link and on an unlink, ["terms"] when only the delta changed).

postWebhookdocument_contract_amendment_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.