ConsentEvent

Notifies subscribers of changes to consent fields or contact information on all core objects. This object is available in API version 50.0 and later.

Supported Calls

describeSObjects()

Supported Subscribers

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

Subscription Channel

/event/ConsentEvent

Special Access Rules

Users with ReadAllData or PrivacyDataAccess permissions have read access.

Event Delivery Allocation Enforced

Yes

Fields

AssociatedIds

Type: string

Properties: Nillable

Description: A list of IDs associated with the changed record. Possible IDs are:

Possible values:

globalPartyId
individual
lead
contact
personAccount
user
contactPoint
contactPointConsent
contactPointTypeConsent

ChangeInitiator

Type: string

Properties: Nillable

Description: The ID of the user who changed the record.

ChangeTimestamp

Type: dateTime

Properties: Nillable

Description: Indicates the date and time the change event occurred.

ChangeType

Type: picklist

Properties: Nillable, Restricted picklist

Description: Indicates the type of change made to the record. Possible values are Create, Delete, Undelete, Unknown, or Update.

ConsentCaptureSource

Type: string

Properties: Nillable

Description: Indicates how consent was captured. For example, if the ConsentCaptureType is a website, the ConsentCaptureSource is the website URL.

ConsentCaptureType

Type: string

Properties: Nillable

Description: Indicates the type of source consent was captured through. For example, a website or online form.

EventUuid

Type: string

Properties: Nillable

Description: A universally unique identifier (UUID) that identifies a platform event message. This field is available in API version 52.0 and later.

NewValues

Type: string

Properties: Nillable

Description: Indicates new values that were added to the object, if relevant.

ObjectName

Type: string

Properties: Nillable

Description: The name of the object for which the change event was captured.

RecordId

Type: string

Properties: Nillable

Description: The ID of the record that was changed.

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.