Overview of DigiFi Communication Events

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

Communication Created

The "communication.created" event occurs when a communication is created, either manually on the platform or via APIs. This includes email and SMS interactions as well as recorded communications. The event data has the following structure:

{
  "object": {
    "id": "69c5949a7c7e5e77b83155f4",
    "productId": "69c594b1fad38b015d578c6d",
    "organizationId": "69c594c75198ee479f874916",
    "applicationId": "69c594dfb98cf0e3c00428e7",
    "applicationDisplayId": "100000",
    "borrowerIds": [
      "69c594f9bb546a1db94c5cea"
    ],
    "intermediaryId": null,
    "recordDate": "2026-03-26T18:50:38.668Z",
    "testing": true,
    "communicationType": "Email",
    "messageStatus": "sent",
    "createdAt": "2026-03-26T18:50:38.999Z",
    "updatedAt": "2026-03-26T18:50:38.999Z",
    "createdBy": "69c595446adac40d633c35d2",
    "updatedBy": "69c595446adac40d633c35d2",
    "content": {
      "to": [
        "johndoe@example.com"
      ],
      "cc": [
        "janedoe@example.com"
      ],
      "bcc": [],
      "from": "example@example.com",
      "subject": "Your loan application has been received",
      "bodyStorageFileId": "69c5951ca8de36ba83e95412",
      "attachmentsCount": 0
    }
  }
}

Communication Updated

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

{
  "previousObject": {
    "id": "69c5949a7c7e5e77b83155f4",
    "productId": "69c594b1fad38b015d578c6d",
    "organizationId": "69c594c75198ee479f874916",
    "applicationId": "69c594dfb98cf0e3c00428e7",
    "applicationDisplayId": "100000",
    "borrowerIds": [
      "69c594f9bb546a1db94c5cea"
    ],
    "intermediaryId": null,
    "recordDate": "2026-03-26T18:52:10.584Z",
    "testing": true,
    "communicationType": "Email",
    "messageStatus": "sentManually",
    "createdAt": "2026-03-26T18:53:03.841Z",
    "updatedAt": "2026-03-26T18:53:03.841Z",
    "createdBy": "69c595446adac40d633c35d2",
    "updatedBy": "69c595446adac40d633c35d2",
    "content": {
      "to": [
        "johndoe@example.com"
      ],
      "cc": [
        "janedoe@example.com"
      ],
      "bcc": [],
      "from": "example@example.com",
      "subject": "Your loan application has been received",
      "body": "Dear John Doe, your loan application has been successfully received and is currently under review.",
      "bodyStorageFileId": null
    }
  },
  "object": {
    "id": "69c5949a7c7e5e77b83155f4",
    "productId": "69c594b1fad38b015d578c6d",
    "organizationId": "69c594c75198ee479f874916",
    "applicationId": "69c594dfb98cf0e3c00428e7",
    "applicationDisplayId": "100000",
    "borrowerIds": [
      "69c594f9bb546a1db94c5cea"
    ],
    "intermediaryId": null,
    "recordDate": "2026-03-25T18:52:00.000Z",
    "testing": true,
    "communicationType": "Email",
    "messageStatus": "sentManually",
    "createdAt": "2026-03-26T18:53:03.841Z",
    "updatedAt": "2026-03-26T18:54:30.069Z",
    "createdBy": "69c595446adac40d633c35d2",
    "updatedBy": "69c595446adac40d633c35d2",
    "content": {
      "to": [
        "johndoe@example.com"
      ],
      "cc": [
        "janedoe@example.com"
      ],
      "bcc": [],
      "from": "example@example.com",
      "subject": "Your loan application has been received",
      "body": "Dear John Doe, your loan application is currently under review. We will notify you once a decision has been made.",
      "bodyStorageFileId": null,
      "bodySource": {
        "type": "doc",
        "content": [
          {
            "type": "paragraph",
            "content": [
              {
                "type": "text",
                "text": "Dear John Doe, your loan application is currently under review. We will notify you once a decision has been made."
              }
            ]
          }
        ]
      }
    }
  }
}

Communication Deleted

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

{
  "object": {
    "id": "69c5949a7c7e5e77b83155f4",
    "productId": "69c594b1fad38b015d578c6d",
    "organizationId": "69c594c75198ee479f874916",
    "applicationId": "69c594dfb98cf0e3c00428e7",
    "applicationDisplayId": "100000",
    "borrowerIds": [
      "69c594f9bb546a1db94c5cea"
    ],
    "intermediaryId": null,
    "recordDate": "2026-03-26T18:50:38.668Z",
    "testing": true,
    "communicationType": "Email",
    "messageStatus": "sent",
    "createdAt": "2026-03-26T18:50:38.999Z",
    "updatedAt": "2026-03-26T18:50:38.999Z",
    "createdBy": "69c595446adac40d633c35d2",
    "updatedBy": "69c595446adac40d633c35d2",
    "content": {
      "to": [
        "johndoe@example.com"
      ],
      "cc": [
        "janedoe@example.com"
      ],
      "bcc": [],
      "from": "example@example.com",
      "subject": "Your loan application has been received",
      "bodyStorageFileId": "69c5951ca8de36ba83e95412",
      "attachmentsCount": 0
    }
  }
}