Overview of DigiFi Task Events

The task events deliver instant notifications to your external applications when specific events occur related to tasks. These events include "task.created," "task.updated," and "task.deleted."

📘
Data Structure (Variables)
DigiFi enables customers to define custom variables to create a unique data structure. Therefore, the structure of the "variables" section of the events will differ by organization. The example below contains a basic set of variables for illustrative purposes.

Task Created

The "task.created" event occurs when a task is created, either manually on the platform or via APIs. The event data has the following structure:

{
        "object": {
            "id": "8ac6f62a5ea9420391036dc452f5f703",
            "title": "Task Title ",
            "status": "Not Done",
            "productId": "5b9f1921aa4b4a32a0be77cedda639a3",
            "applicationId": "c2759c61ecbb4ae2b6603b44d9016b6c",
            "applicationDisplayId": "100000",
            "labelIds": [
                "65bf924b64c26284f8b027fb"
            ],
            "assignedTeamMemberIds": [
                "e1aa864941664b3baebf07d4c71b5a70"
            ],
            "version": 0,
            "externalAssignee": {
                "id": "8fa71bc8c6de45ac951501dbaf0d73e4",
                "assigneeType": "borrower",
                "name": "John Doe",
                "borrowerType": "person"
            },
            "dueDateAndTime": "2024-04-26T09:00:00.000Z",
            "createdAt": "2024-04-02T20:46:33.597Z",
            "updatedAt": "2024-04-02T20:46:33.597Z",
            "description": "Task Title ",
            "shouldSendAssignmentEmail": true,
            "internalInstructions": "These are internal instructions.",
            "externalInstructions": "These are external instructions.",
            "blockedApplicationStatusIds": [
                "9af161a345924e24b7fa9515d99b9deb"
            ],
            "autoPassCondition": {
                "formula": "EQUAL(information_verified, true)",
                "formulaRequiredVariables": [
                    "information_verified"
                ]
            },
            "sendExternalAssignmentEmail": true,
            "testing": false,
            "variables": [
                "bank_routing_number"
            ],
            "organizationId": "e2cb5fcc40dd49288c38663715bba729",
            "createdById": "c44b6f429a9f4aeabb489ae4899b562a",
            "updatedById": "c44b6f429a9f4aeabb489ae4899b562a",
            "assigneeType": "borrower",
            "dueDate": "04/26/2024",
            "application": {
                "id": "4c34a47787dc4adab45ec2f6f61a3f6e",
                "displayId": "100000",
                "borrower": {
                    "id": "aa4e59dd25db44cb83f8d6d0cb29ccba",
                    "type": "person"
                },
                "variables": {
                    "borrower_first_name": "John",
                    "borrower_last_name": "Doe",
                    "intermediary_name": "LoanOn"
                },
                "teamMembers": [
                    "fd618f8c8aae4abc8a10aee8ad5373a2"
                ]
            },
            "blockedStatuses": [
                {
                    "id": "7334d0541b3d4883bb9003a0e262b59a",
                    "name": "Approved"
                }
            ],
            "assignedBorrower": {
                "id": "aa4e59dd25db44cb83f8d6d0cb29ccba",
                "type": "person",
                "variables": {
                    "borrower_first_name": "John",
                    "borrower_last_name": "Doe",
                    "borrower_email": "johndoe@test.com"
                }
            },
            "createdBy": {
                "id": "ce423091c53b4e6ea3ccd3beb4757703",
                "email": "example@example.com",
                "color": "#88A8D1",
                "firstName": "Team",
                "lastName": "Member",
                "avatarId": "b244610c-8b8a-4150-a43a-a65cd71cb2cc"
            },
            "updatedBy": {
                "id": "ce423091c53b4e6ea3ccd3beb4757703",
                "email": "example@example.com",
                "color": "#88A8D1",
                "firstName": "Team",
                "lastName": "Member",
                "avatarId": "b244610c-8b8a-4150-a43a-a65cd71cb2cc"
            }
        }
    },
    "createdAt": "2023-05-19T14:34:37.155Z"
}

Task Updated

The "task.updated" event occurs when a task is updated, either manually on the platform or via APIs. The event data has the following structure:

{
        "previousObject": {
            "id": "8ac6f62a5ea9420391036dc452f5f703",
            "title": "Task Title ",
            "status": "Not Done",
            "productId": "5b9f1921aa4b4a32a0be77cedda639a3",
            "applicationId": "c2759c61ecbb4ae2b6603b44d9016b6c",
            "applicationDisplayId": "100000",
            "labelIds": [
                "65bf924b64c26284f8b027fb"
            ],
            "assignedTeamMemberIds": [
                "e1aa864941664b3baebf07d4c71b5a70"
            ],
            "version": 0,
            "externalAssignee": {
                "id": "8fa71bc8c6de45ac951501dbaf0d73e4",
                "assigneeType": "borrower",
                "name": "John Doe",
                "borrowerType": "person"
            },
            "dueDateAndTime": "2024-04-26T09:00:00.000Z",
            "createdAt": "2024-04-02T20:46:33.597Z",
            "updatedAt": "2024-04-02T20:46:33.597Z",
            "description": "Task Title ",
            "shouldSendAssignmentEmail": true,
            "internalInstructions": "These are internal instructions.",
            "externalInstructions": "These are external instructions.",
            "blockedApplicationStatusIds": [
                "9af161a345924e24b7fa9515d99b9deb"
            ],
            "autoPassCondition": {
                "formula": "EQUAL(information_verified, true)",
                "formulaRequiredVariables": [
                    "information_verified"
                ]
            },
            "sendExternalAssignmentEmail": true,
            "testing": false,
            "variables": [
                "bank_routing_number"
            ],
            "organizationId": "e2cb5fcc40dd49288c38663715bba729",
            "createdById": "c44b6f429a9f4aeabb489ae4899b562a",
            "updatedById": "c44b6f429a9f4aeabb489ae4899b562a",
            "assigneeType": "borrower",
            "dueDate": "04/26/2024",
            "application": {
                "id": "4c34a47787dc4adab45ec2f6f61a3f6e",
                "displayId": "100000",
                "borrower": {
                    "id": "aa4e59dd25db44cb83f8d6d0cb29ccba",
                    "type": "person"
                },
                "variables": {
                    "borrower_first_name": "John",
                    "borrower_last_name": "Doe",
                    "intermediary_name": "LoanOn"
                },
                "teamMembers": [
                    "fd618f8c8aae4abc8a10aee8ad5373a2"
                ]
            },
            "blockedStatuses": [
                {
                    "id": "7334d0541b3d4883bb9003a0e262b59a",
                    "name": "Approved"
                }
            ],
            "assignedBorrower": {
                "id": "aa4e59dd25db44cb83f8d6d0cb29ccba",
                "type": "person",
                "variables": {
                    "borrower_first_name": "John",
                    "borrower_last_name": "Doe",
                    "borrower_email": "johndoe@test.com"
                }
            },
            "createdBy": {
                "id": "ce423091c53b4e6ea3ccd3beb4757703",
                "email": "example@example.com",
                "color": "#88A8D1",
                "firstName": "Team",
                "lastName": "Member",
                "avatarId": "b244610c-8b8a-4150-a43a-a65cd71cb2cc"
            },
            "updatedBy": {
                "id": "ce423091c53b4e6ea3ccd3beb4757703",
                "email": "example@example.com",
                "color": "#88A8D1",
                "firstName": "Team",
                "lastName": "Member",
                "avatarId": "b244610c-8b8a-4150-a43a-a65cd71cb2cc"
            }
        },
        "object": {
            "id": "8ac6f62a5ea9420391036dc452f5f703",
            "title": "New Task Title ",
            "status": "Not Done",
            "productId": "5b9f1921aa4b4a32a0be77cedda639a3",
            "applicationId": "c2759c61ecbb4ae2b6603b44d9016b6c",
            "applicationDisplayId": "100000",
            "labelIds": [
                "65bf924b64c26284f8b027fb"
            ],
            "assignedTeamMemberIds": [
                "e1aa864941664b3baebf07d4c71b5a70"
            ],
            "version": 0,
            "externalAssignee": {
                "id": "8fa71bc8c6de45ac951501dbaf0d73e4",
                "assigneeType": "borrower",
                "name": "John Doe",
                "borrowerType": "person"
            },
            "dueDateAndTime": "2024-04-26T09:00:00.000Z",
            "createdAt": "2024-04-02T20:46:33.597Z",
            "updatedAt": "2024-04-02T20:46:33.597Z",
            "description": "Task Title ",
            "shouldSendAssignmentEmail": true,
            "internalInstructions": "These are internal instructions.",
            "externalInstructions": "These are external instructions.",
            "blockedApplicationStatusIds": [
                "9af161a345924e24b7fa9515d99b9deb"
            ],
            "autoPassCondition": {
                "formula": "EQUAL(information_verified, true)",
                "formulaRequiredVariables": [
                    "information_verified"
                ]
            },
            "sendExternalAssignmentEmail": true,
            "testing": false,
            "variables": [
                "bank_routing_number"
            ],
            "organizationId": "e2cb5fcc40dd49288c38663715bba729",
            "createdById": "c44b6f429a9f4aeabb489ae4899b562a",
            "updatedById": "c44b6f429a9f4aeabb489ae4899b562a",
            "assigneeType": "borrower",
            "dueDate": "04/26/2024",
            "application": {
                "id": "4c34a47787dc4adab45ec2f6f61a3f6e",
                "displayId": "100000",
                "borrower": {
                    "id": "aa4e59dd25db44cb83f8d6d0cb29ccba",
                    "type": "person"
                },
                "variables": {
                    "borrower_first_name": "John",
                    "borrower_last_name": "Doe",
                    "intermediary_name": "LoanOn"
                },
                "teamMembers": [
                    "fd618f8c8aae4abc8a10aee8ad5373a2"
                ]
            },
            "blockedStatuses": [
                {
                    "id": "7334d0541b3d4883bb9003a0e262b59a",
                    "name": "Approved"
                }
            ],
            "assignedBorrower": {
                "id": "aa4e59dd25db44cb83f8d6d0cb29ccba",
                "type": "person",
                "variables": {
                    "borrower_first_name": "John",
                    "borrower_last_name": "Doe",
                    "borrower_email": "johndoe@test.com"
                }
            },
            "createdBy": {
                "id": "ce423091c53b4e6ea3ccd3beb4757703",
                "email": "example@example.com",
                "color": "#88A8D1",
                "firstName": "Team",
                "lastName": "Member",
                "avatarId": "b244610c-8b8a-4150-a43a-a65cd71cb2cc"
            },
            "updatedBy": {
                "id": "ce423091c53b4e6ea3ccd3beb4757703",
                "email": "example@example.com",
                "color": "#88A8D1",
                "firstName": "Team",
                "lastName": "Member",
                "avatarId": "b244610c-8b8a-4150-a43a-a65cd71cb2cc"
            }
        }
    },
    "createdAt": "2023-05-19T14:34:37.155Z"
}

Task Deleted

The "task.deleted" event occurs when a task is deleted, either manually on the platform or via APIs. The event data has the following structure:

{
        "object": {
            "id": "8ac6f62a5ea9420391036dc452f5f703",
            "title": "New Task Title ",
            "status": "Not Done",
            "productId": "5b9f1921aa4b4a32a0be77cedda639a3",
            "applicationId": "c2759c61ecbb4ae2b6603b44d9016b6c",
            "applicationDisplayId": "100000",
            "labelIds": [
                "65bf924b64c26284f8b027fb"
            ],
            "assignedTeamMemberIds": [
                "e1aa864941664b3baebf07d4c71b5a70"
            ],
            "version": 0,
            "externalAssignee": {
                "id": "8fa71bc8c6de45ac951501dbaf0d73e4",
                "assigneeType": "borrower",
                "name": "John Doe",
                "borrowerType": "person"
            },
            "dueDateAndTime": "2024-04-26T09:00:00.000Z",
            "createdAt": "2024-04-02T20:46:33.597Z",
            "updatedAt": "2024-04-02T20:46:33.597Z",
            "description": "Task Title ",
            "shouldSendAssignmentEmail": true,
            "internalInstructions": "These are internal instructions.",
            "externalInstructions": "These are external instructions.",
            "blockedApplicationStatusIds": [
                "9af161a345924e24b7fa9515d99b9deb"
            ],
            "autoPassCondition": {
                "formula": "EQUAL(information_verified, true)",
                "formulaRequiredVariables": [
                    "information_verified"
                ]
            },
            "sendExternalAssignmentEmail": true,
            "testing": false,
            "variables": [
                "bank_routing_number"
            ],
            "organizationId": "e2cb5fcc40dd49288c38663715bba729",
            "createdById": "c44b6f429a9f4aeabb489ae4899b562a",
            "updatedById": "c44b6f429a9f4aeabb489ae4899b562a",
            "assigneeType": "borrower",
            "dueDate": "04/26/2024",
            "application": {
                "id": "4c34a47787dc4adab45ec2f6f61a3f6e",
                "displayId": "100000",
                "borrower": {
                    "id": "aa4e59dd25db44cb83f8d6d0cb29ccba",
                    "type": "person"
                },
                "variables": {
                    "borrower_first_name": "John",
                    "borrower_last_name": "Doe",
                    "intermediary_name": "LoanOn"
                },
                "teamMembers": [
                    "fd618f8c8aae4abc8a10aee8ad5373a2"
                ]
            },
            "blockedStatuses": [
                {
                    "id": "7334d0541b3d4883bb9003a0e262b59a",
                    "name": "Approved"
                }
            ],
            "assignedBorrower": {
                "id": "aa4e59dd25db44cb83f8d6d0cb29ccba",
                "type": "person",
                "variables": {
                    "borrower_first_name": "John",
                    "borrower_last_name": "Doe",
                    "borrower_email": "johndoe@test.com"
                }
            },
            "createdBy": {
                "id": "ce423091c53b4e6ea3ccd3beb4757703",
                "email": "example@example.com",
                "color": "#88A8D1",
                "firstName": "Team",
                "lastName": "Member",
                "avatarId": "b244610c-8b8a-4150-a43a-a65cd71cb2cc"
            },
            "updatedBy": {
                "id": "ce423091c53b4e6ea3ccd3beb4757703",
                "email": "example@example.com",
                "color": "#88A8D1",
                "firstName": "Team",
                "lastName": "Member",
                "avatarId": "b244610c-8b8a-4150-a43a-a65cd71cb2cc"
            }
        }
    },
    "createdAt": "2023-05-19T14:34:37.155Z"
}