Use the Consent Event Stream

Use one stream to receive notifications about changes to consent fields or contact information on all core objects. When your users change an object, an event is emitted into the stream with information about the change. This information is available to view for 24 hours.

Required Editions

Available in: Lightning Experience and Salesforce Classic in Enterprise, Performance, Unlimited, and Developer editions

User Permissions Needed
To use the Consent Event Stream:	ReadAllData or PrivacyDataAccess

The Consent Event Stream monitors changes to consent fields and contact information for these objects:

Object	Field
Authorization Form Consent	Status Authorization Form Text Consent Captured Source Party Consent Captured Source Type Consent Captured Date Consent Giver Name
Contact	Individual Email Phone Mobile Other Phone Do Not Call Home Phone Email Opt Out Fax Opt Out
Contact Point Consent	Data Use Purpose Double Consent Capture Date Privacy Consent Status Capture Source Contact Point Capture Contact Point Type Effective From Capture Date Effective To Name
Contact Point Address	Parent Address Address Type Name Active From Active To
Contact Point Email	Parent Active To Active From Email Address Name
Contact Point Phone	Parent Phone Type Active To Date Active From Date Area Code Telephone Number Name
Contact Point Type Consent	Data Use Purpose Double Consent Capture Date Privacy Consent Status Capture Source Capture Contact Point Type Email Effective From Capture Date Contact Point Type Effective To Date Name Engagement Channel Type
Communication Subscription Consent	Consent Captured Source Contact Point Effective From Date Effective To Date Consent Captured DateTime Consent Giver Name Comm Subscription Channel Type
Individual	Name Block Geolocation Tracking Don’t Process Don’t Profile Don’t Market Don’t Track OK to Store PII Data Elsewhere Forget this Individual Export Individual’s Data
Lead	Email Do Not Call Address Phone Has Opted Out Of Email Has Opted Out Of Fax Mobile Phone Individual
Party Consent	Action Party Double Consent Capture Date Privacy Consent Status Capture Source Capture Contact Point Type Phone Effective From Capture Date Effective To Name
Person Account	Person Home Phone Person Do Not Call Person Has Opted Out Of Fax Person Mailing Address Phone Person Mobile Phone Person Individual Person Other Phone Person Assistant Phone Person Email Person Has Opted Out Of Email Person Other Address
User	Email Address Phone Mobile Phone Individual

From Setup, in the Quick Find Box, enter Consent Event Stream, and then select Consent Event Stream.
Select Use the consent event stream.
Subscribe to the channel /event/ConsentEvent. For more information, see Subscribing to Platform Events

Example channel /event/ConsentEvent


{
  “data”: {
    “schema”: “GzuA-iAALq0ABxW_WNjlag”,
    “payload”: {
      “TenantId”: null,
      “NewValues”: “{\”ShouldForget\”:true}”,
      “ConsentCaptureSource”:”com/salesforce/api/soap/47.0;client”,
      “CreatedById”: “0054J000002fRxBQAU”,
      “ChangeType”: 1,
      “ConsentCaptureType”: null,
      “ChangeInitiator”: “0054J000002HEa4QAG”,
      “CreatedDate”: “2019-11-18T01:36:39.536z”,
      “RecordId”: 0PK4J000000CabiWAC”,
      “ChangeTimeStamp”: “2019-11-18T01:36:37:000z”,
      “GlobalPartyId”: null,
      “ObjectName”: “Individual”        }
    },
    “event”: {
      “replayId”: 287
    },
    “channel”: “/event/ConsentEvent”
}