Overview of DigiFi Intermediary Events

The intermediary events deliver instant notifications to your external applications when specific events occur related to intermediaries. These events include "intermediary.created," "intermediary.updated," and "intermediary.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.

Intermediary Created

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

{
        "object": {
            "id": "b15d92745503417d9ee3c8c5",
            "organizationId": "aed495486e14443690cb50979",
            "testing": true,
            "variables": {
                "intermediary_name": "Intermediary",
                "intermediary_email": "intermediary@example.com",
                "intermediary_phone": "+1234567890",
                "intermediary_id_number": "9999999999",
                "intermediary_type": "contractor",
                "intermediary_address": {
                  "street_number": "123",
                  "street_name": "Street",
                  "unit_number": "2",
                  "city": "Los Angeles",
                  "state_or_province": "CA",
                  "zip_or_postal_code": "12345",
                  "country": "US"
                }
            },
            "createdBy": {
                "id": "5fa43179-39fa44f7944f3ccf",
                "firstName": "Team",
                "lastName": "Member",
                "email": "example@example.com",
                "phone": "*********0000",
                "isMfaEnabled": true,
                "isEmailVerified": true,
                "avatarParams": {
                    "originalFileName": "image.png",
                    "canvasHeight": 600,
                    "canvasWidth": 400,
                    "cropRect": {
                        "height": 268.52367688022287,
                        "width": 268.52367688022287,
                        "x": 171.33813714582607,
                        "y": 65.73816155988857
                    },
                    "imageRect": {
                        "height": 268.52367688022287,
                        "width": 268.52367688022287,
                        "x": 171.33813714582607,
                        "y": 65.73816155988857
                    },
                    "id": "229f293a-7nj6-78n-noma-8e095eaf9f2c-184669daa710184669daa7100010a8c0b6d-41d2e493-7nh5-6bnj-6754-7d66a64f5e36"
                },
                "notificationBlacklist": [],
                "avatarId": "229f293a-7nj6-78n-noma-8e095eaf9f2c-184669daa710184669daa7100010a8c0b6d-41d2e493-7nh5-6bnj-6754-7d66a64f5e36"
            },
            "updatedBy": {
                "id": "5fa43179-39fa44f7944f3ccf",
                "firstName": "Team",
                "lastName": "Member",
                "email": "example@example.com",
                "phone": "*********0000",
                "isMfaEnabled": true,
                "isEmailVerified": true,
                "avatarParams": {
                    "originalFileName": "image.png",
                    "canvasHeight": 600,
                    "canvasWidth": 400,
                    "cropRect": {
                        "height": 268.52367688022287,
                        "width": 268.52367688022287,
                        "x": 171.33813714582607,
                        "y": 65.73816155988857
                    },
                    "imageRect": {
                        "height": 268.52367688022287,
                        "width": 268.52367688022287,
                        "x": 171.33813714582607,
                        "y": 65.73816155988857
                    },
                    "id": "229f293a-7nj6-78n-noma-8e095eaf9f2c-184669daa710184669daa7100010a8c0b6d-41d2e493-7nh5-6bnj-6754-7d66a64f5e36"
                },
                "notificationBlacklist": [],
                "avatarId": "229f293a-7nj6-78n-noma-8e095eaf9f2c-184669daa710184669daa7100010a8c0b6d-41d2e493-7nh5-6bnj-6754-7d66a64f5e36"
            },
            "createdAt": "2023-05-19T13:12:46.190Z",
            "updatedAt": "2023-05-19T13:12:46.190Z"
        }
    },
    "createdAt": "2023-05-19T13:12:46.198Z"
}

Intermediary Updated

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

{
        "object": {
            "id": "b15d92745503417d9ee3c8c5",
            "organizationId": "aed495486e14443690cb50979",
            "testing": true,
            "variables": {
                "intermediary_name": "Intermediary",
                "intermediary_email": "intermediary@example.com",
                "intermediary_phone": "+1111111111",
                "intermediary_id_number": "9999999999",
                "intermediary_type": "contractor",
                "intermediary_address": {
                  "street_number": "123",
                  "street_name": "Street",
                  "unit_number": "2",
                  "city": "Los Angeles",
                  "state_or_province": "CA",
                  "zip_or_postal_code": "12345",
                  "country": "US"
                }
            },
            "createdBy": {
                "id": "5fa43179-39fa44f7944f3ccf",
                "firstName": "Team",
                "lastName": "Member",
                "email": "example@example.com",
                "phone": "*********0000",
                "isMfaEnabled": true,
                "isEmailVerified": true,
                "avatarParams": {
                    "originalFileName": "image.png",
                    "canvasHeight": 600,
                    "canvasWidth": 400,
                    "cropRect": {
                        "height": 268.52367688022287,
                        "width": 268.52367688022287,
                        "x": 171.33813714582607,
                        "y": 65.73816155988857
                    },
                    "imageRect": {
                        "height": 268.52367688022287,
                        "width": 268.52367688022287,
                        "x": 171.33813714582607,
                        "y": 65.73816155988857
                    },
                    "id": "229f293a-7nj6-78n-noma-8e095eaf9f2c-184669daa710184669daa7100010a8c0b6d-41d2e493-7nh5-6bnj-6754-7d66a64f5e36"
                },
                "notificationBlacklist": [],
                "avatarId": "229f293a-7nj6-78n-noma-8e095eaf9f2c-184669daa710184669daa7100010a8c0b6d-41d2e493-7nh5-6bnj-6754-7d66a64f5e36"
            },
            "updatedBy": {
                "id": "5fa43179-39fa44f7944f3ccf",
                "firstName": "Team",
                "lastName": "Member",
                "email": "example@example.com",
                "phone": "*********0000",
                "isMfaEnabled": true,
                "isEmailVerified": true,
                "avatarParams": {
                    "originalFileName": "image.png",
                    "canvasHeight": 600,
                    "canvasWidth": 400,
                    "cropRect": {
                        "height": 268.52367688022287,
                        "width": 268.52367688022287,
                        "x": 171.33813714582607,
                        "y": 65.73816155988857
                    },
                    "imageRect": {
                        "height": 268.52367688022287,
                        "width": 268.52367688022287,
                        "x": 171.33813714582607,
                        "y": 65.73816155988857
                    },
                    "id": "229f293a-7nj6-78n-noma-8e095eaf9f2c-184669daa710184669daa7100010a8c0b6d-41d2e493-7nh5-6bnj-6754-7d66a64f5e36"
                },
                "notificationBlacklist": [],
                "avatarId": "229f293a-7nj6-78n-noma-8e095eaf9f2c-184669daa710184669daa7100010a8c0b6d-41d2e493-7nh5-6bnj-6754-7d66a64f5e36"
            },
            "createdAt": "2023-05-19T13:12:46.190Z",
            "updatedAt": "2023-05-19T13:12:46.190Z"
        },
        "previousObject": {
            "id": "b15d92745503417d9ee3c8c5",
            "organizationId": "aed495486e14443690cb50979",
            "testing": true,
            "variables": {
                "intermediary_name": "Intermediary",
                "intermediary_email": "intermediary@example.com",
                "intermediary_phone": "+1234567890",
                "intermediary_id_number": "9999999999",
                "intermediary_type": "contractor",
                "intermediary_address": {
                  "street_number": "123",
                  "street_name": "Street",
                  "unit_number": "2",
                  "city": "Los Angeles",
                  "state_or_province": "CA",
                  "zip_or_postal_code": "12345",
                  "country": "US"
                }
            },
            "createdBy": {
                "id": "5fa43179-39fa44f7944f3ccf",
                "firstName": "Team",
                "lastName": "Member",
                "email": "example@example.com",
                "phone": "*********0000",
                "isMfaEnabled": true,
                "isEmailVerified": true,
                "avatarParams": {
                    "originalFileName": "image.png",
                    "canvasHeight": 600,
                    "canvasWidth": 400,
                    "cropRect": {
                        "height": 268.52367688022287,
                        "width": 268.52367688022287,
                        "x": 171.33813714582607,
                        "y": 65.73816155988857
                    },
                    "imageRect": {
                        "height": 268.52367688022287,
                        "width": 268.52367688022287,
                        "x": 171.33813714582607,
                        "y": 65.73816155988857
                    },
                    "id": "229f293a-7nj6-78n-noma-8e095eaf9f2c-184669daa710184669daa7100010a8c0b6d-41d2e493-7nh5-6bnj-6754-7d66a64f5e36"
                },
                "notificationBlacklist": [],
                "avatarId": "229f293a-7nj6-78n-noma-8e095eaf9f2c-184669daa710184669daa7100010a8c0b6d-41d2e493-7nh5-6bnj-6754-7d66a64f5e36"
            },
            "updatedBy": {
                "id": "5fa43179-39fa44f7944f3ccf",
                "firstName": "Team",
                "lastName": "Member",
                "email": "example@example.com",
                "phone": "*********0000",
                "isMfaEnabled": true,
                "isEmailVerified": true,
                "avatarParams": {
                    "originalFileName": "image.png",
                    "canvasHeight": 600,
                    "canvasWidth": 400,
                    "cropRect": {
                        "height": 268.52367688022287,
                        "width": 268.52367688022287,
                        "x": 171.33813714582607,
                        "y": 65.73816155988857
                    },
                    "imageRect": {
                        "height": 268.52367688022287,
                        "width": 268.52367688022287,
                        "x": 171.33813714582607,
                        "y": 65.73816155988857
                    },
                    "id": "229f293a-7nj6-78n-noma-8e095eaf9f2c-184669daa710184669daa7100010a8c0b6d-41d2e493-7nh5-6bnj-6754-7d66a64f5e36"
                },
                "notificationBlacklist": [],
                "avatarId": "229f293a-7nj6-78n-noma-8e095eaf9f2c-184669daa710184669daa7100010a8c0b6d-41d2e493-7nh5-6bnj-6754-7d66a64f5e36"
            },
            "createdAt": "2023-05-19T13:12:46.190Z",
            "updatedAt": "2023-05-19T13:12:46.190Z"
        }
    },
    "createdAt": "2023-05-19T13:18:35.116Z"
}

Intermediary Deleted

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

{
        "object": {
            "id": "b15d92745503417d9ee3c8c5",
            "organizationId": "aed495486e14443690cb50979",
            "testing": true,
            "variables": {
                "intermediary_name": "Intermediary",
                "intermediary_email": "intermediary@example.com",
                "intermediary_phone": "+1234567890",
                "intermediary_id_number": "9999999999",
                "intermediary_type": "contractor",
                "intermediary_address": {
                  "street_number": "123",
                  "street_name": "Street",
                  "unit_number": "2",
                  "city": "Los Angeles",
                  "state_or_province": "CA",
                  "zip_or_postal_code": "12345",
                  "country": "US"
                }
            },
            "createdBy": {
                "id": "5fa43179-39fa44f7944f3ccf",
                "firstName": "Team",
                "lastName": "Member",
                "email": "example@example.com",
                "phone": "*********0000",
                "isMfaEnabled": true,
                "isEmailVerified": true,
                "avatarParams": {
                    "originalFileName": "image.png",
                    "canvasHeight": 600,
                    "canvasWidth": 400,
                    "cropRect": {
                        "height": 268.52367688022287,
                        "width": 268.52367688022287,
                        "x": 171.33813714582607,
                        "y": 65.73816155988857
                    },
                    "imageRect": {
                        "height": 268.52367688022287,
                        "width": 268.52367688022287,
                        "x": 171.33813714582607,
                        "y": 65.73816155988857
                    },
                    "id": "229f293a-7nj6-78n-noma-8e095eaf9f2c-184669daa710184669daa7100010a8c0b6d-41d2e493-7nh5-6bnj-6754-7d66a64f5e36"
                },
                "notificationBlacklist": [],
                "avatarId": "229f293a-7nj6-78n-noma-8e095eaf9f2c-184669daa710184669daa7100010a8c0b6d-41d2e493-7nh5-6bnj-6754-7d66a64f5e36"
            },
            "updatedBy": {
                "id": "5fa43179-39fa44f7944f3ccf",
                "firstName": "Team",
                "lastName": "Member",
                "email": "example@example.com",
                "phone": "*********0000",
                "isMfaEnabled": true,
                "isEmailVerified": true,
                "avatarParams": {
                    "originalFileName": "image.png",
                    "canvasHeight": 600,
                    "canvasWidth": 400,
                    "cropRect": {
                        "height": 268.52367688022287,
                        "width": 268.52367688022287,
                        "x": 171.33813714582607,
                        "y": 65.73816155988857
                    },
                    "imageRect": {
                        "height": 268.52367688022287,
                        "width": 268.52367688022287,
                        "x": 171.33813714582607,
                        "y": 65.73816155988857
                    },
                    "id": "229f293a-7nj6-78n-noma-8e095eaf9f2c-184669daa710184669daa7100010a8c0b6d-41d2e493-7nh5-6bnj-6754-7d66a64f5e36"
                },
                "notificationBlacklist": [],
                "avatarId": "229f293a-7nj6-78n-noma-8e095eaf9f2c-184669daa710184669daa7100010a8c0b6d-41d2e493-7nh5-6bnj-6754-7d66a64f5e36"
            },
            "createdAt": "2023-05-19T13:12:46.190Z",
            "updatedAt": "2023-05-19T13:12:46.190Z"
        }
    },
    "createdAt": "2023-05-19T13:12:46.198Z"
}