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.

describeSObjects()

SubscriberSupported?
Apex TriggersYes
FlowsYes
ProcessesYes
Pub/Sub APIYes
Streaming API (CometD)Yes

/event/ConsentEvent

Users with ReadAllData or PrivacyDataAccess permissions have read access.

Yes

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

Type: string

Properties: Nillable

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

Type: dateTime

Properties: Nillable

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

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.

Type: string

Properties: Nillable

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

Type: string

Properties: Nillable

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

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.

Type: string

Properties: Nillable

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

Type: string

Properties: Nillable

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

Type: string

Properties: Nillable

Description: The ID of the record that was changed.

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.