Overview of DigiFi Note Events

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

Note Created

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

{
        "object": {
            "id": "6046ab9e73bc4250b569a8301e",
            "note": "Notes",
            "author": {
                "id": "bdc9d3f8902743dfa496f06e39",
                "firstName": "Team",
                "lastName": "Member",
                "avatarId": "229f293a-7nj6-78n-noma-8e095eaf9f2c-184669daa710184669daa7100010a8c0b6d-41d2e493-7nh5-6bnj-6754-7d66a64f5e36"
            },
            "updatedBy": "6046ab9e73bc4250b569a8301e",
            "organizationId": "c87a23f5fa26444283052bff3ef",
            "testing": true,
            "createdAt": "2023-05-19T13:51:19.942Z",
            "updatedAt": "2023-05-19T13:51:19.942Z",
            "applicationId": "1b4ed5d37f5341a5aca54d423c"
        }
    },
    "createdAt": "2023-05-19T13:51:19.947Z"
}

Note Updated

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

{
        "object": {
            "id": "6046ab9e73bc4250b569a8301e",
            "note": "Changed notes",
            "author": {
                "id": "bdc9d3f8902743dfa496f06e39",
                "firstName": "Team",
                "lastName": "Member",
                "avatarId": "229f293a-7nj6-78n-noma-8e095eaf9f2c-184669daa710184669daa7100010a8c0b6d-41d2e493-7nh5-6bnj-6754-7d66a64f5e36"
            },
            "updatedBy": "6046ab9e73bc4250b569a8301e",
            "organizationId": "c87a23f5fa26444283052bff3ef",
            "testing": true,
            "createdAt": "2023-05-19T13:51:19.942Z",
            "updatedAt": "2023-05-19T13:51:19.942Z",
            "applicationId": "1b4ed5d37f5341a5aca54d423c"
        },
        "previousObject": {
            "id": "6046ab9e73bc4250b569a8301e",
            "note": "Notes",
            "author": {
                "id": "bdc9d3f8902743dfa496f06e39",
                "firstName": "Team",
                "lastName": "Member",
                "avatarId": "229f293a-7nj6-78n-noma-8e095eaf9f2c-184669daa710184669daa7100010a8c0b6d-41d2e493-7nh5-6bnj-6754-7d66a64f5e36"
            },
            "updatedBy": "6046ab9e73bc4250b569a8301e",
            "organizationId": "c87a23f5fa26444283052bff3ef",
            "testing": true,
            "createdAt": "2023-05-19T13:51:19.942Z",
            "updatedAt": "2023-05-19T13:51:19.942Z",
            "applicationId": "1b4ed5d37f5341a5aca54d423c"
        }
    },
    "createdAt": "2023-05-19T13:52:23.607Z"
}

Note Deleted

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

{
        "object": {
            "id": "6046ab9e73bc4250b569a8301e",
            "note": "Notes",
            "author": {
                "id": "bdc9d3f8902743dfa496f06e39",
                "firstName": "Team",
                "lastName": "Member",
                "avatarId": "229f293a-7nj6-78n-noma-8e095eaf9f2c-184669daa710184669daa7100010a8c0b6d-41d2e493-7nh5-6bnj-6754-7d66a64f5e36"
            },
            "updatedBy": "6046ab9e73bc4250b569a8301e",
            "organizationId": "c87a23f5fa26444283052bff3ef",
            "testing": true,
            "createdAt": "2023-05-19T13:51:19.942Z",
            "updatedAt": "2023-05-19T13:51:19.942Z",
            "applicationId": "1b4ed5d37f5341a5aca54d423c"
        }
    },
    "createdAt": "2023-05-19T13:51:19.947Z"
}