Newer Version Available

This content describes an older version of this product. View Latest

DataObjectDataChgEvent

Notifies subscribers of an action within Customer Data Platform. This object is available in API version 53.0 and later.

Supported Calls

describeSObjects()

Supported Subscribers

Subscriber Supported?
Apex Triggers Yes
Flows Yes
Processes Yes
Pub/Sub API Yes
Streaming API (CometD) Yes

Subscription Channel

/event/DataObjectDataChgEvent

Special Access Rules

DataObjectDataChgEvent is available only if Customer Data Platform is enabled.

Fields

Field Details
ActionDeveloperName
Type
string
Properties
Nillable
Description
The developer name associated with this action.
EventCreationDateTime
Type
dateTime
Properties
Nillable
Description
The date and time when the event occurred.
EventPrompt
Type
picklist
Properties
Nillable, Restricted Picklist
Description
The data manipulation language action that triggered this event.
Possible values are:
  • DELETE
  • INSERT
  • UPDATE
EventPublishDateTime
Type
dateTime
Properties
Nillable
Description
The date and time when the event was published.
EventSchemaVersion
Type
string
Properties
Nillable
Description
The version of the event schema.
EventType
Type
string
Properties
Nillable
Description
The type of event that occurred.
EventUuid
Type
string
Properties
Nillable
Description
A universally unique identifier (UUID) that identifies a platform event message.
Offset
Type
string
Properties
Nillable
Description
The number of rows to skip before starting to return.
PayloadCurrentValue
Type
textarea
Properties
Nillable
Description
Current data values with enriched fields.
PayloadPrevValue
Type
textarea
Properties
Nillable
Description
Previous data values with enriched fields. This field is optional depending on the source object.
PayloadSchema
Type
textarea
Properties
Nillable
Description
The schema for the event payload.
ReplayId
Type
string
Properties
Nillable
Description
Represents an ID value that is populated by the system and refers to the position of the event in the event stream. Replay ID values aren’t guaranteed to be contiguous for consecutive events. A subscriber can store a replay ID value and use it on resubscription to retrieve missed events that are within the retention window.
SourceObjectDeveloperName
Type
string
Properties
Nillable
Description
The developer name of the object that triggered the data change event.