Document Event Names represent the types of events that are automatically created and recorded when document-related operations occur within a workflow. These events provide an audit trail and can be retrieved using the workflow.requiredDocument.events.list endpoint.

Available Types

Type	Description
DOCUMENT_COMMENT_ADDED	Event created when a comment is added to a document. Reserved for future implementation of document comment functionality.
DOCUMENT_FILES_REQUESTED	Event created when document files are explicitly requested from a user. Triggered by workflow.requiredDocument.batchRequestDocuments endpoint.
DOCUMENT_FILES_UPLOADED	Event created when a document is linked to a required document via fulfillment. Triggered by workflow.requiredDocument.fulfillment.batchAdd endpoint.
FULFILLMENT_COMMENT_ADDED	Event created when a comment is added to a fulfillment. Triggered by workflow.requiredDocument.fulfillment.addComment endpoint.
FULFILLMENT_STATUS_CHANGED	Event created when a fulfillment's decision status is updated (e.g., from NEEDS_REVIEW to ACCEPTED). Triggered by workflow.requiredDocument.fulfillment.update endpoint.
REQUIRED_DOCUMENT_ADDED	Event created when a new required document is added to a workflow. Triggered by workflow.requiredDocument.batchAdd or workflow.requiredDocument.calculate endpoints.
REQUIRED_DOCUMENT_COMPLETED	Event created when a required document's status changes to COMPLETED. Triggered by workflow.requiredDocument.batchUpdate endpoint or automatic status calculation.
REQUIRED_DOCUMENT_INCOMPLETED	Event created when a completed required document's status changes back to NEEDS_REVIEW. Triggered by workflow.requiredDocument.batchUpdate endpoint.
REQUIRED_DOCUMENT_REMOVED	Event created when a required document is marked as removed/inactive. Triggered by workflow.requiredDocument.batchUpdate endpoint with status change to INACTIVE.
REQUIRED_DOCUMENT_RESTORED	Event created when a previously removed required document is restored to active status. Triggered by workflow.requiredDocument.batchUpdate endpoint.