Event Types

Event Types & Format

There are 3 types of Publication events

Data

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.

Schema

Schema event types include messages from creating, updating, deleting schema (e.g. objects, fields) in your site from DealCloud object management. This is relatively infrequent. Messages can be consumed from the default-schema topic only.

User

User event type include user and user group related messages, such as creating, updating, or deleting users or user groups. Messages can be consumed from the default-users topic only.

Edge Scenarios

There's always possiibility of edge scenarios or uncommon messages. We've listed some below.

  1. Splitting Up Large Schema Messages
    Although uncommon, some messages may be too large in payload size to send as a single message. In these scenarios, we will split the messages and use the properties isLastPart (boolean) and partNumber (int) to split up messages.

  2. Oversized Text Fields
    For text fields that are larger than 10,000 characters, isLargeText: true will be returned and not the actual value. This may be seen in rich-text fields. A standard REST API call can be made to retrieve the full value.