HomeGuidesAPI ReferenceChangelogDiscussions
GuidesAPI ReferenceDiscussions

Workflow Completed

Event Type

workflowCompleted

Entity Action

COMPLETED

Firing Condition

When a consumer completes an application workflow. Not triggered for Lender-entered applications.

Valid Decorators

  • losPrimaryKey
  • crmPrimaryKey
  • originationType
  • metadata.documentYear
  • referenceLoanNumber
  • metadata.memberEntityIdentifier
  • borrower.econsentMetadata
  • metadata.assetIdentifier

Valid Milestones

  • GETTING_STARTED
  • GETTING_TO_KNOW_YOU
  • ASSETS
  • INCOME
  • REAL_ESTATE_OWNED
  • DECLARATIONS
  • DEMOGRAPHIC_INFORMATION
  • ADDITIONAL_QUESTIONS

Object Format

{
  "eventType": "workflowEvent",
  "eventId": UUID,
  "message": {
    "entityAction": "COMPLETED",
    "entityId": UUID,
    "milestone": ENUM
  },
  "originallyEmittedAt": DateTime (UTC Unix/Epoch Timestamp),
  "status": "EMITTED"
}