Integration Event

The structure of the webhook event related to integrations.

Overview of DigiFi Integration Event

When the “externalIntegration.processed” event for which the webhook is registered occurs, the DigiFi platform sends a notification to your application.

📘

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.


External Integration Processed

The "externalIntegration.processed" event occurs when an integration is run, either manually on the platform or via APIs. The event data has the following structure:

{
    "eventId": "c64d6e8bdf2749fbb1b0e7cca2f8a767",
    "eventType": "externalIntegration.processed",
    "data": {
        "id": "efbfb9d9d1e8424d9845780d6862fae7",
        "applicationId": "2898739113094aa682036e28b27459ac",
        "runBy": "65c134963ab944caa17adbf5899495fb",
        "integrationName": "Soft Credit Pull Report",
        "status": 200,
        "result": "completed",
        "inputs": {
            "borrower_first_name": "John",
            "borrower_home_address": {
                "street_number": "123",
                "street_name": "Street",
                "city": "Los Angeles",
                "state_or_province": "CA",
                "zip_or_postal_code": "12345"
            },
            "borrower_last_name": "Doe",
            "borrower_date_of_birth": "12/12/1990",
            "borrower_personal_id_number": "999999999"
        },
        "outputs": {
            "borrower_credit_score": 720,
            "borrower_mla_alert": "Not In The Military",
            "borrower_ofac_alert": "No OFAC Match"
        }
    },
    "createdAt": "2023-05-19T14:34:37.142Z"
}