Docs
Publications
Event Types
Data

Publications Data Events

Data events are the most relevant and frequent messages and probably what you care about the most. It includes all updates, creations, and deletions of records (or values within records) throughout the system.

Example: A new deal was created, a contact's email was updated, a memo was deleted, etc.

Data messages follow a similar model to the standard Data REST APIs, supporting both the Cells and Rows format.

Rows

Note: When a record is created, you will usually get 2 items in the payload, a created item and an updated item. The create only includes the new entryID of the record created while the subsequent updated item includes the actual fields and data added to the new record.

[
  {
    "eventId": "f60f5482-14d0-465d-b955-7319f3ccd2ea",
    "modifiedAt": "2025-04-29T23:36:18.287Z",
    "topicName": "data",
    "topicOffset": 0,
    "entityType": "Data",
    "entityFormatType": "Rows",
    "modifiedById": 2447,
    "modifiedByUserEmail": "admin.user@company.com",
    "isCalculated": false,
    "schemaVersion": 52,
    "payload": {
      "entities": {
        "created": [
          {
            "entries": [
              {
                "entryId": 908915
              }
            ],
            "entryListId": 2072
          }
        ],
        "updated": [
          {
            "entryFields": [
              {
                "EntryName": "Test Company",
                "EntryId": 908915,
                "EntryListId": 2072,
                "Name": "Test Company",
                "phonenumber": "2131232312",
                "Domain": "http://test.com",
                "dateofstart": "2022-04-28T21:00:00Z"
              }
            ],
            "entryListId": 2072
          }
        ]
      }
    }
  }
]

Cells

When publishing the data as Cells we return the current value. When the field is a Choice or Reference we return ActionType, This is done by adding ActionType to the value object. The ActionType can be INSERT or DELETE.

200 OK
Date: Wed, 27 Apr 2022 22:08:01 GMT
Content-Type: application/json; charset=utf-8
 
[
  {
    "eventId": "430c8c1a-c764-4688-9f22-29290e443db7",
    "modifiedAt": "2022-04-27T14:46:42.393Z",
    "topicName": "data65",
    "topicOffset": 32,
    "entityType": "Data",
    "entityFormatType": "None",
    "modifiedById": 2447,
    "modifiedByUserEmail": "admin.user@company.com",
    "isCalculated": false,
    "schemaVersion": 47,
    "payload": {
      "entities": {
        "updated": [
          {
            "entryFields": [
              {
                "fieldId": 288292,
                "value": [
                  {
                    "ActionType": "UPDATE",
                    "Url": "mailto:admin@dealcloud.com",
                    "IsFile": null,
                    "Type": 0,
                    "Id": 1,
                    "Name": "Admin Admin",
                    "EntryListId": -1
                  },
                  {
                    "Url": "mailto:cperrautqa@dealcloud.com",
                    "IsFile": null,
                    "Type": 0,
                    "Id": 1003660,
                    "Name": "Charles QA Test User",
                    "EntryListId": -1
                  }
                ],
                "entryId": 33868851
              },
              {
                "fieldId": 288294,
                "value": [
                  {
                    "ActionType": "INSERT",
                    "ParentID": null,
                    "SeqNumber": 1,
                    "IsAutoPdf": false,
                    "Id": 17440232,
                    "Name": "Buyout (PE / Corporate Held)",
                    "EntryListId": -6
                  }
                ],
                "entryId": 33868851
              },
              {
                "fieldId": 288295,
                "value": [
                  {
                    "ActionType": "DELETE",
                    "ParentID": null,
                    "SeqNumber": 1,
                    "IsAutoPdf": false,
                    "Id": 17440239,
                    "Name": "Auction",
                    "EntryListId": -6
                  }
                ],
                "entryId": 33868851
              }
        ]
      }
    }
  }
]
Event TypesSchema