Publications Schema Events

Any changes to the DealCloud site schema (typically done through Object Management) will be streamed to the default-schema topic. This will include updates to any objects or fields within the site.

The schemaVersion property can be used to track changes to the DealCloud site schema and is sent with every schema and data event message.

ℹ

Note: a response can contain multiple events and one or more event types. For example, a response can have an update, create, and delete in the same response.

Payload Examples

An event indicating a new object called Example Object was created

[
  {
    "eventId": "042d0539-8480-494b-8bd2-2b93795994dc",
    "modifiedAt": "2023-01-20T15:15:58.84Z",
    "topicName": "default-schema",
    "topicOffset": 5,
    "entityType": "EntryLists",
    "entityFormatType": "None",
    "modifiedById": 1003660,
    "modifiedByUserEmail": "admin.user@company.com",
    "schemaVersion": 48,
    "payload": {
      "entities": {
        "created": [
          {
            "apiName": "ExampleObject",
            "singularName": "Example Object",
            "pluralName": "Example Objects",
            "entryListId": -5,
            "entryListType": 1,
            "entryListSubType": 0,
            "id": 661840,
            "name": "Example Object"
          }
        ]
      }
    }
  }
]

Data User