Types

DocumentHistoryEvent

One signature or settings event recorded for a document.

idrequired
string (uuid)
The event's id.
typerequired
string
signature: a signature request on the document changed state. settings: the document's own download or watermark setting was changed.One of: signature, settings
statusrequired
string | null
For a signature event, the status the signature reached. Null for a settings event.
actioned_byrequired
object
The user who made the change.
actioned_onrequired
object | null
The user the change was about, such as the signer. Null when the change was not about a user.
reasonrequired
string | null
What changed, in words, such as "allow_download changed from on to off".
errorrequired
string | null
Why the change failed, when it did.
signature_idrequired
string | null (uuid)
The signature the event belongs to. Null for a settings event.
created_atrequired
string (date-time)
When the event happened.
updated_atrequired
string | null (date-time)
When the record last changed. Null if it never did.

Used by (1)