Event catalog

This page lists every event Formable sends to your webhook endpoint. Most integrations only need signing events (document_viewed, document_signed, document_completed). Redlining events are listed below for the optional negotiation workflow. Every payload shares the same top-level shape — an event metadata object plus a category-specific object:

{
  "event": {
    "event_id": "string",
    "event_category": "signing | redlining",
    "event_type": "string",
    "event_time": 1777039156023
  },
  "signing": { }
}

string

Unique identifier for this delivery. Use it for idempotency.

string

Either signing or redlining.

string

The specific event type, listed below.

number

When the event occurred, in milliseconds since the Unix epoch.

Signing events

Signing events carry a signing object and reference a signature request.

string

The ID of the signature request the event relates to.

`document_viewed`

The signer opened the document for the first time.

{
  "event": {
    "event_id": "p-1phZC6_oU8qS191gsLT",
    "event_category": "signing",
    "event_type": "document_viewed",
    "event_time": 1777039156023
  },
  "signing": {
    "signature_request_id": "YfdkOH7dVtaGzl-egS6NI"
  }
}

`document_signed`

A single signer completed and signed the document. This does not mean the signed PDF is ready yet — wait for document_completed before fetching the signed envelope.

string

The ID of the recipient who signed. Matches the recipientSignatureId returned when you create a signature request.

{
  "event": {
    "event_id": "p-1phZC6_oU8qS191gsLT",
    "event_category": "signing",
    "event_type": "document_signed",
    "event_time": 1777039156023
  },
  "signing": {
    "signature_request_id": "YfdkOH7dVtaGzl-egS6NI",
    "recipient_signature_id": "rsig_789ghi"
  }
}

`document_completed`

All required fields are filled, the signature request is complete, and the signed PDF (with audit trail) is ready to download. If there are multiple signers, this means all signers have signed. Wait for this event before calling Get signed envelope.

{
  "event": {
    "event_id": "p-1phZC6_oU8qS191gsLT",
    "event_category": "signing",
    "event_type": "document_completed",
    "event_time": 1777039156023
  },
  "signing": {
    "signature_request_id": "YfdkOH7dVtaGzl-egS6NI"
  }
}

Redlining events

Redlining events carry a redlining object and reference a redline request. Every redlining payload includes these base fields, plus any event-specific fields listed below.

string

The ID of the redline request the event relates to.

string

The role of the member who triggered the event. One of disclosing_party, receiving_party, disclosing_counsel, or receiving_counsel.

`redline_edit_inserted`

A member inserted new text into the document.

string

The inserted text.

{
  "event": {
    "event_id": "n9c8123umxrs082rum",
    "event_category": "redlining",
    "event_type": "redline_edit_inserted",
    "event_time": 1777039156023
  },
  "redlining": {
    "redline_request_id": "92cn47yxm92smsmdw",
    "redline_member_role": "disclosing_party",
    "redline_edit_insertion": "including any amendments hereto"
  }
}

`redline_edit_deleted`

A member deleted text from the document.

string

The deleted text.

{
  "event": {
    "event_id": "n9c8123umxrs082rum",
    "event_category": "redlining",
    "event_type": "redline_edit_deleted",
    "event_time": 1777039156023
  },
  "redlining": {
    "redline_request_id": "92cn47yxm92smsmdw",
    "redline_member_role": "receiving_party",
    "redline_edit_deletion": "within thirty (30) days"
  }
}

`redline_edit_accepted`

A member accepted a tracked change proposed by the other party.

string

The content of the change that was accepted.

string

The kind of change. One of inserted, deleted, replaced, or formatted.

{
  "event": {
    "event_id": "n9c8123umxrs082rum",
    "event_category": "redlining",
    "event_type": "redline_edit_accepted",
    "event_time": 1777039156023
  },
  "redlining": {
    "redline_request_id": "92cn47yxm92smsmdw",
    "redline_member_role": "disclosing_party",
    "content": "net sixty (60) days",
    "change_type": "replaced"
  }
}

`redline_edit_rejected`

A member rejected a tracked change proposed by the other party.

string

The content of the change that was rejected.

string

The kind of change. One of inserted, deleted, replaced, or formatted.

{
  "event": {
    "event_id": "n9c8123umxrs082rum",
    "event_category": "redlining",
    "event_type": "redline_edit_rejected",
    "event_time": 1777039156023
  },
  "redlining": {
    "redline_request_id": "92cn47yxm92smsmdw",
    "redline_member_role": "receiving_party",
    "content": "exclusive jurisdiction of the courts of Delaware",
    "change_type": "inserted"
  }
}

`redline_comment_added`

A member added a comment to the document.

string

The comment text.

{
  "event": {
    "event_id": "n9c8123umxrs082rum",
    "event_category": "redlining",
    "event_type": "redline_comment_added",
    "event_time": 1777039156023
  },
  "redlining": {
    "redline_request_id": "92cn47yxm92smsmdw",
    "redline_member_role": "receiving_party",
    "comment_added": "Can we clarify the definition of Confidential Information here?"
  }
}

`redline_message_added`

A member posted a message in the negotiation thread.

string

The message text.

string

The email address of the message author.

{
  "event": {
    "event_id": "n9c8123umxrs082rum",
    "event_category": "redlining",
    "event_type": "redline_message_added",
    "event_time": 1777039156023
  },
  "redlining": {
    "redline_request_id": "92cn47yxm92smsmdw",
    "redline_member_role": "disclosing_party",
    "message": "Please review the liability cap.",
    "author_email": "counsel@example.com"
  }
}

`redline_turn_ended`

A member finished their turn and passed the document to the other party. Only the base redlining fields are included.

{
  "event": {
    "event_id": "n9c8123umxrs082rum",
    "event_category": "redlining",
    "event_type": "redline_turn_ended",
    "event_time": 1777039156023
  },
  "redlining": {
    "redline_request_id": "92cn47yxm92smsmdw",
    "redline_member_role": "receiving_party"
  }
}

`document_ready_for_signing`

All tracked changes have been resolved and the document is ready to be sent for signature. Only the base redlining fields are included.

{
  "event": {
    "event_id": "n9c8123umxrs082rum",
    "event_category": "redlining",
    "event_type": "document_ready_for_signing",
    "event_time": 1777039156023
  },
  "redlining": {
    "redline_request_id": "92cn47yxm92smsmdw",
    "redline_member_role": "disclosing_party"
  }
}

`redline_shared`

A redline request was shared with a member. Only the base redlining fields are included.

{
  "event": {
    "event_id": "n9c8123umxrs082rum",
    "event_category": "redlining",
    "event_type": "redline_shared",
    "event_time": 1777039156023
  },
  "redlining": {
    "redline_request_id": "92cn47yxm92smsmdw",
    "redline_member_role": "disclosing_party"
  }
}

Handling events

Switch on event.event_type to route each event. Unknown types should be ignored gracefully so new event types don’t break your handler.

switch (payload.event.event_type) {
  case "document_completed":
    await onDocumentCompleted(payload.signing.signature_request_id);
    break;
  case "document_ready_for_signing":
    await onReadyForSigning(payload.redlining.redline_request_id);
    break;
  // ...handle other types you care about
  default:
    // Ignore unrecognized event types.
    break;
}

Getting Started

Walkthroughs

SDKs

Migrations

Webhooks

Signing events

`document_viewed`

`document_signed`

`document_completed`

Redlining events

`redline_edit_inserted`

`redline_edit_deleted`

`redline_edit_accepted`

`redline_edit_rejected`

`redline_comment_added`

`redline_message_added`

`redline_turn_ended`

`document_ready_for_signing`

`redline_shared`

Handling events

​Signing events

​document_viewed

​document_signed

​document_completed

​Redlining events

​redline_edit_inserted

​redline_edit_deleted

​redline_edit_accepted

​redline_edit_rejected

​redline_comment_added

​redline_message_added

​redline_turn_ended

​document_ready_for_signing

​redline_shared

​Handling events

Signing events

`document_viewed`

`document_signed`

`document_completed`

Redlining events

`redline_edit_inserted`

`redline_edit_deleted`

`redline_edit_accepted`

`redline_edit_rejected`

`redline_comment_added`

`redline_message_added`

`redline_turn_ended`

`document_ready_for_signing`

`redline_shared`

Handling events