Extra Payload Attributes - Loan Resources

These attributes make up the extra payload for various events for the Loan webhook resource:

Alert Changes Attributes

ATTRIBUTE
alertChanges.alertTypeId
string
alertChanges.name
string
alertChanges.type
string
alertChanges.status
string
alertChanges.alertDate
string
alertChanges.displayDate
string
alertChanges.message
string
alertChanges.associations
array

Attachment Attributes

ATTRIBUTE
attachmentCreated.id
string
attachmentCreated.title
string

Condition Attributes

ATTRIBUTE
updateStatusTrackingInConditions.id
string
updateStatusTrackingInConditions.title
string
updateStatusTrackingInConditions.type
string
updateStatusTrackingInConditions.status
string
documentStatusUpdates.documents.id
string
documentStatusUpdates.documents.title
string
documentStatusUpdates.id
string
documentStatusUpdates.title
string
documentStatusUpdates.type
string
addCommentsToConditions.comments.commentId
string
addCommentsToConditions.comments.isExternal
boolean
addCommentsToConditions.id
string
addCommentsToConditions.title
string
addCommentsToConditions.type
string
createConditions.id
string
createConditions.title
string
createConditions.type
string
assignDocumentsToConditions.documents.id
string
assignDocumentsToConditions.documents.title
string
assignDocumentsToConditions.id
string
assignDocumentsToConditions.title
string
assignDocumentsToConditions.type
string

Document Attributes

ATTRIBUTE
assignAttachmentsToDocument.id
string
assignAttachmentsToDocument.title
string
assignAttachmentsToDocument.attachmentIds
array
documentStatusUpdates.selectedStatuses.status
string
documentStatusUpdates.selectedStatuses.lastModifiedAt
string
documentStatusUpdates.selectedStatuses.lastUpdateBy
string
documentStatusUpdates.selectedStatuses.currentStatus
boolean
documentStatusUpdates.attachmentIds
array
updateDocuments.id
string
updateDocuments.title
string

Enhanced Field Change Attributes

ATTRIBUTE
fieldChangeEvents.multipartIndicator
string
fieldChangeEvents.modifiedField
string
fieldChangeEvents.parentFieldId
string
fieldChangeEvents.encompass.previousValue
string
fieldChangeEvents.encompass.newValue
string
fieldChangeEvents.v3LoanModel.previousValue
string
fieldChangeEvents.v3LoanModel.newValue
string

Milestone Attributes

ATTRIBUTE
updateMilestones.id
string
updateMilestones.title
string

Webhook Payload Notification Samples

{
  "eventId": "db445b93-9ba8-42c4-956b-ee3095940b7b",
  "eventTime": "2024-11-19T22:04:00.303Z",
  "eventType": "alertchange",
  "meta": {
    "userId": "admin",
    "resourceType": "Loan",
    "resourceId": "5232a41f-0dc7-43d8-93da-ebeaac99e1d6",
    "instanceId": "be11105680j",
    "resourceRef": "/encompass/v1/loans/5232a41f-0dc7-43d8-93da-ebeaac99e1d6/alerts",
    "payload": {
      "event": {
        "alertChanges": [
          {
            "alertTypeId": "Regulation:Ability-To-RepayLoanTypeNotDetermined",
            "name": "Ability-To-Repay Loan Type Not Determined",
            "type": "Regulation",
            "status": "Open",
            "alertDate": "2024-11-19T08:00:00Z",
            "displayDate": "2024-11-19T08:00:00Z",
            "message": "Ability-to-Repay standards have not been documented. Verify that loan is exempt, a qualified mortgage or being made subject to general ability-to-repay standards.",
            "associations": []
          }
        ]
      }
    }
  }
}
{
    "eventId": "9a2296dc-5888-4e51-847f-0076c1bad9e2",
    "eventTime": "2024-11-20T04:42:28.227Z",
    "eventType": "attachment",
    "meta": {
        "userId": "admin",
        "resourceType": "Loan",
        "resourceId": "80bd70ee-fda0-4dbd-a7e8-f84b9be026ab",
        "instanceId": "be11105680j",
        "resourceRef": "/encompass/v3/loans/80bd70ee-fda0-4dbd-a7e8-f84b9be026ab/attachments",
        "payload": {
            "event": {
                "attachmentCreated": [
                    {
                        "id": "EBSP23444.pdf",
                        "title": "First Attachment"
                    }
                ]
            }
        }
    }
}
    "eventId": "8f780b2b-09a8-4f44-ab60-981d31f6b5e2",
    "eventTime": "2024-11-18T19:41:19.475Z",
    "eventType": "condition",
    "meta": {
        "userId": "admin",
        "resourceType": "Loan",
        "resourceId": "a07c3604-555d-4553-9de7-5b3e87b6bce0",
        "instanceId": "be11105680j",
        "resourceRef": "/encompass/v3/loans/a07c3604-555d-4553-9de7-5b3e87b6bce0/condition",
        "payload": {
            "event": {
                "updateStatusTrackingInConditions": [
                    {
                        "id": "bcc324eb-8b08-4515-82a1-2fcebe35dc15",
                        "title": "E00BSAUTO_Income - Personal Tax Returns1",
                        "type": "ggudfff4dsf",
                        "status": [
                            "Requested"
                        ]
                    }
                ],
                "documentStatusUpdates": [
                    {
                        "documents": [
                            {
                                "id": "e0a626af-ca87-4678-8f98-7360de856b08",
                                "title": "ETR Test Document 1"
                            }
                        ],
                        "id": "bcc324eb-8b08-4515-82a1-2fcebe35dc15",
                        "title": "E00BSAUTO_Income - Personal Tax Returns1",
                        "type": "ggudfff4dsf"
                    }
                ],
                "addCommentsToConditions": [
                    {
                        "comments": [
                            {
                                "commentId": "e68df8c4-47be-4382-8833-44c373bc3506",
                                "isExternal": false
                            },
                            {
                                "commentId": "f9dd902a-8b3f-4c67-abe6-09f218ec54af",
                                "isExternal": false
                            }
                        ],
                        "id": "bcc324eb-8b08-4515-82a1-2fcebe35dc15",
                        "title": "E00BSAUTO_Income - Personal Tax Returns1",
                        "type": "ggudfff4dsf"
                    }
                ],
                "createConditions": [
                    {
                        "id": "bcc324eb-8b08-4515-82a1-2fcebe35dc15",
                        "title": "E00BSAUTO_Income - Personal Tax Returns1",
                        "type": "ggudfff4dsf"
                    }
                ],
                "assignDocumentsToConditions": [
                    {
                        "documents": [
                            {
                                "id": "e0a626af-ca87-4678-8f98-7360de856b08",
                                "title": "ETR Test Document 1"
                            }
                        ],
                        "id": "bcc324eb-8b08-4515-82a1-2fcebe35dc15",
                        "title": "E00BSAUTO_Income - Personal Tax Returns1",
                        "type": "ggudfff4dsf"
                    }
                ]
            }
        }
    }
}
{
    "eventId": "72f280e3-533b-4198-9593-ebd34e459934",
    "eventTime": "2024-11-20T04:44:08.896Z",
    "eventType": "document",
    "meta": {
        "userId": "admin",
        "resourceType": "Loan",
        "resourceId": "80bd70ee-fda0-4dbd-a7e8-f84b9be026ab",
        "instanceId": "be11105680j",
        "resourceRef": "/encompass/v3/loans/80bd70ee-fda0-4dbd-a7e8-f84b9be026ab/document",
        "payload": {
            "event": {
                "assignAttachmentsToDocument": [
                    {
                        "id": "56999564-e263-42d6-b70a-c20641da85ec",
                        "title": "ETR Test Document",
                        "attachmentIds": [
                            "EBSP23444.pdf"
                        ]
                    }
                ],
                "documentStatusUpdates": [
                    {
                        "id": "56999564-e263-42d6-b70a-c20641da85ec",
                        "selectedStatuses": [
                            {
                                "status": "received",
                                "lastModifiedAt": "2024-11-20T04:44:07Z",
                                "lastUpdateBy": "admin",
                                "currentStatus": true
                            }
                        ],
                        "attachmentIds": [
                            "EBSP23444.pdf"
                        ]
                    }
                ],
                "updateDocuments": [
                    {
                        "id": "56999564-e263-42d6-b70a-c20641da85ec",
                        "title": "ETR Test Document"
                    }
                ]
            }
        }
    }
}
{
    "eventId": "c70cd0c9-6c7e-4d80-9cda-db9df4481e94",
    "eventTime": "2024-11-19T22:50:27.179Z",
    "eventType": "enhancedfieldchange",
    "meta": {
        "userId": "<ddaconnect>",
        "resourceType": "Loan",
        "resourceId": "5232a41f-0dc7-43d8-93da-ebeaac99e1d6",
        "instanceId": "be11105680j",
        "resourceRef": "/encompass/v3/loans/5232a41f-0dc7-43d8-93da-ebeaac99e1d6/enhancedFieldChange",
        "payload": {
            "event": {
                "multipartIndicator": "4/10",
                "fieldChangeEvents": [
                    {
                        "modifiedField": "LOANFILESEQUENCENUMBER",
                        "parentFieldId": "LOANFILESEQUENCENUMBER",
                        "encompass": {
                            "previousValue": "15",
                            "newValue": "16"
                        },
                        "v3LoanModel": {
                            "previousValue": "15",
                            "newValue": "16"
                        }
                    },
                    {
                        "modifiedField": "CUST37FV",
                        "parentFieldId": "CUST37FV",
                        "encompass": {
                            "previousValue": "11/12/2024",
                            "newValue": "11/19/2024"
                        },
                        "v3LoanModel": {
                            "previousValue": "11/12/2024",
                            "newValue": "11/19/2024"
                        }
                    },
                    {
                        "modifiedField": "CX.CUST90FV5",
                        "parentFieldId": "CX.CUST90FV5",
                        "encompass": {
                            "previousValue": "11/12/2024",
                            "newValue": "11/19/2024"
                        },
                        "v3LoanModel": {
                            "previousValue": "11/12/2024",
                            "newValue": "11/19/2024"
                        }
                    },
                    {
                        "modifiedField": "CX.DATE.CALC",
                        "parentFieldId": "CX.DATE.CALC",
                        "encompass": {
                            "previousValue": "11/12/2024",
                            "newValue": "11/19/2024"
                        },
                        "v3LoanModel": {
                            "previousValue": "11/12/2024",
                            "newValue": "11/19/2024"
                        }
                    },
                    {
                        "modifiedField": "CUST30FV",
                        "parentFieldId": "CUST30FV",
                        "encompass": {
                            "previousValue": "a52f82ee-740d-4883-9",
                            "newValue": "0217bad8-8f1b-4f73-a"
                        },
                        "v3LoanModel": {
                            "previousValue": "a52f82ee-740d-4883-9",
                            "newValue": "0217bad8-8f1b-4f73-a"
                        }
                    },
                    {
                        "modifiedField": "CX.CUST90FV4",
                        "parentFieldId": "CX.CUST90FV4",
                        "encompass": {
                            "previousValue": "11/12/2024",
                            "newValue": "11/19/2024"
                        },
                        "v3LoanModel": {
                            "previousValue": "11/12/2024",
                            "newValue": "11/19/2024"
                        }
                    },
                    {
                        "modifiedField": "CX.CUST36FV4",
                        "parentFieldId": "CX.CUST36FV4",
                        "encompass": {
                            "previousValue": "11/12/2024",
                            "newValue": "11/19/2024"
                        },
                        "v3LoanModel": {
                            "previousValue": "11/12/2024",
                            "newValue": "11/19/2024"
                        }
                    },
                    {
                        "modifiedField": "CX.CUST36V4",
                        "parentFieldId": "CX.CUST36V4",
                        "encompass": {
                            "previousValue": "11/12/2024",
                            "newValue": "11/19/2024"
                        },
                        "v3LoanModel": {
                            "previousValue": "11/12/2024",
                            "newValue": "11/19/2024"
                        }
                    },
                    {
                        "modifiedField": "CX.CUST00FV",
                        "parentFieldId": "CX.CUST00FV",
                        "encompass": {
                            "previousValue": "4c468d51-626a-4",
                            "newValue": "29d7637f-9225-4"
                        },
                        "v3LoanModel": {
                            "previousValue": "4c468d51-626a-4",
                            "newValue": "29d7637f-9225-4"
                        }
                    },
                    {
                        "modifiedField": "CX.CUST100FV",
                        "parentFieldId": "CX.CUST100FV",
                        "encompass": {
                            "previousValue": "11/12/2024 12:00:00 AM",
                            "newValue": "11/19/2024 12:00:00 AM"
                        },
                        "v3LoanModel": {
                            "previousValue": "11/12/2024 12:00:00 AM",
                            "newValue": "11/19/2024 12:00:00 AM"
                        }
                    },
                    {
                        "modifiedField": "CX.TODAY",
                        "parentFieldId": "CX.TODAY",
                        "encompass": {
                            "previousValue": "11/12/2024",
                            "newValue": "11/19/2024"
                        },
                        "v3LoanModel": {
                            "previousValue": "11/12/2024",
                            "newValue": "11/19/2024"
                        }
                    },
                    {
                        "modifiedField": "CX.CBIZ59280",
                        "parentFieldId": "CX.CBIZ59280",
                        "encompass": {
                            "previousValue": "3",
                            "newValue": "25"
                        },
                        "v3LoanModel": {
                            "previousValue": "3",
                            "newValue": "25"
                        }
                    },
                    {
                        "modifiedField": "CX.CUST36FV5",
                        "parentFieldId": "CX.CUST36FV5",
                        "encompass": {
                            "previousValue": "11/12/2024",
                            "newValue": "11/19/2024"
                        },
                        "v3LoanModel": {
                            "previousValue": "11/12/2024",
                            "newValue": "11/19/2024"
                        }
                    },
                    {
                        "modifiedField": "CUST32FV",
                        "parentFieldId": "CUST32FV",
                        "encompass": {
                            "previousValue": "11/15/2024",
                            "newValue": "11/22/2024"
                        },
                        "v3LoanModel": {
                            "previousValue": "11/15/2024",
                            "newValue": "11/22/2024"
                        }
                    }
                ]
            }
        }
    }
}
{
  "eventId": "1e01270f-b62a-4615-b699-2aecd129ec1b",
  "eventTime": "2024-11-20T05:01:36.006Z",
  "eventType": "milestone",
  "meta": {
    "userId": "admin",
    "resourceType": "Loan",
    "resourceId": "e19cb193-5b36-415b-964e-4b4e80e7a769",
    "instanceId": "be11105680j",
    "resourceRef": "/encompass/v3/loans/e19cb193-5b36-415b-964e-4b4e80e7a769/milestone",
    "payload": {
      "event": {
        "updateMilestones": [
          {
            "id": "74d3ba1f-3008-4a65-92d5-de00eb1e9c6a",
            "title": "Started"
          },
          {
            "id": "5769d610-4f1e-4cd2-94f2-facceff7286c",
            "title": "Qualification"
          },
          {
            "id": "0c940eab-12d3-4ecd-8a5b-561f31896f3a",
            "title": "Processing"
          },
          {
            "id": "f479bb89-9c0f-4d2f-8148-2bb73c8900a1",
            "title": "Submittal"
          },
          {
            "id": "7569772e-c674-4d7d-af86-42a777c8a097",
            "title": "Cond. Approval"
          },
          {
            "id": "a0284ecb-f85a-43f6-9fa1-146c17c15edf",
            "title": "Resubmittal"
          },
          {
            "id": "93266476-b936-4f63-8f02-9bf69cbb86cf",
            "title": "Approval"
          },
          {
            "id": "4d6df093-c710-47dc-a884-39796273fe2c",
            "title": "Doc Preparation"
          },
          {
            "id": "2563f82d-9c99-44c7-a278-2eed52acc339",
            "title": "Docs Signing"
          },
          {
            "id": "4565737d-bb44-4557-91de-51b874019648",
            "title": "Kurinji_Funding"
          },
          {
            "id": "07fb2956-e0b0-49a9-be2e-84ff6befd1c4",
            "title": "Post Closing"
          },
          {
            "id": "4fc2b306-2b37-42a9-8c3a-f7ae9b336ca9",
            "title": "Shipping"
          },
          {
            "id": "3ff82281-4092-493a-ba6b-7bb0644d1464",
            "title": "Completion"
          }
        ]
      }
    }
  }
}