The following document events can be subscribed to by your application.
| Event code | Description |
|---|
| document_merged | Occurs when a recipient has had a document merged (generated) and opened it for viewing |
| document_signed | Occurs when a signatory has fully electronically signed a document |
| Field | Type | Description |
|---|
| id | string (uuid) | See How do I secure my notification URL? |
| alg | string | See How do I secure my notification URL? |
| sentAt | date (ISO 8601-1:2019) | When the notification was sent |
| event | string | "document_merged" |
| document_id | string (uuid) | The document ID |
| recipient_id | string (uuid) | The recipient ID who opened |
| recipient_reference | string | Optional. Round-trip reference of the recipient originally supplied by you |
| file_id | string (uuid) | File UUID |
| file_reference | string | File reference of the the file |
🚧
The document is unlikely to be legally executed (binding) at this stage. Users shouldn't use this event for the purpose of knowing when a document has been fully signed and executed. For that, use "file_filed".
| Field | Type | Description |
|---|
| id | string (uuid) | See How do I secure my notification URL? |
| alg | string | See How do I secure my notification URL? |
| sentAt | date (ISO 8601-1:2019) | When the notification was sent |
| event | string | "document_signed" |
| document_id | string (uuid) | The document ID |
| recipient_id | string (uuid) | The recipient ID who signed |
| recipient_reference | string | Optional. Round-trip reference of the recipient originally supplied by you |
| file_id | string (uuid) | File UUID |
| file_reference | string | File reference of the the file |
