---
schema_version: "1"
id: e7f47a87a307307b5d8e5061bb4517033502481411fe94f33a0301fd6324bb96
title: Use the Consent Event Stream
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/xcloud/264-0-0/consent_event_stream.md
canonical_url: https://help.salesforce.com/s/articleView?id=xcloud.consent_event_stream.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: 6196eb015d0013a668ab0873ae6bd68e97d2c2b2dd9c0f4c5c75046bd0b76678
description: 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.
products:
  - Security
  - Cross Cloud
release: "264"
---
# 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

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small edition"><colgroup><col></colgroup><tbody><tr class=""><td class="slds-cell-wrap" style="vertical-align:top;">Available in: Lightning Experience and Salesforce Classic in <strong>Enterprise</strong>, <strong>Performance</strong>, <strong>Unlimited</strong>, and <strong>Developer</strong> editions</td></tr></tbody></table>

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small permission">
        <colgroup>
          <col style="width:50%">
          <col style="width:50%">
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="colgroup" class="slds-cell-wrap" colspan="2" style="text-align:center;vertical-align:top;" id="d11370e46">User Permissions Needed</th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="User Permissions Needed" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e46 ">To use the Consent Event Stream:</td>
            <td class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e46 ">ReadAllData or PrivacyDataAccess</td>
          </tr>
        </tbody>
      </table>

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

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
          <colgroup>
            <col style="width:50%">
            <col style="width:50%">
          </colgroup>
          <thead class="slds-text-title_caps ">
            <tr class="">
              <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d11370e63">Object</th>
              <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d11370e65">Field</th>
            </tr>
          </thead>
          <tbody>
            <tr class="">
              <td data-label="Object" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e63 ">Authorization Form Consent</td>
              <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e65 ">
                <ul>
                  <li>Status</li>
                  <li>Authorization Form Text</li>
                  <li>Consent Captured Source</li>
                  <li>Party</li>
                  <li>Consent Captured Source Type</li>
                  <li>Consent Captured Date </li>
                  <li>Consent Giver</li>
                  <li>Name</li>
                </ul>
              </td>
            </tr>
            <tr class="">
              <td data-label="Object" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e63 ">Contact</td>
              <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e65 ">
                <ul>
                  <li>Individual</li>
                  <li>Email</li>
                  <li>Phone</li>
                  <li>Mobile</li>
                  <li>Other Phone</li>
                  <li>Do Not Call</li>
                  <li>Home Phone</li>
                  <li>Email Opt Out</li>
                  <li>Fax Opt Out</li>
                </ul>
              </td>
            </tr>
            <tr class="">
              <td data-label="Object" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e63 ">Contact Point Consent</td>
              <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e65 ">
                <ul>
                  <li>Data Use Purpose</li>
                  <li>Double Consent Capture Date</li>
                  <li>Privacy Consent Status</li>
                  <li>Capture Source</li>
                  <li>Contact Point</li>
                  <li>Capture Contact Point Type</li>
                  <li>Effective From</li>
                  <li>Capture Date</li>
                  <li>Effective To</li>
                  <li>Name</li>
                </ul>
              </td>
            </tr>
            <tr class="">
              <td data-label="Object" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e63 ">Contact Point Address</td>
              <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e65 ">
                <ul>
                  <li>Parent</li>
                  <li>Address</li>
                  <li>Address Type</li>
                  <li>Name</li>
                  <li>Active From</li>
                  <li>Active To</li>
                </ul>
              </td>
            </tr>
            <tr class="">
              <td data-label="Object" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e63 ">Contact Point Email</td>
              <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e65 ">
                <ul>
                  <li>Parent</li>
                  <li>Active To</li>
                  <li>Active From</li>
                  <li>Email Address</li>
                  <li>Name</li>
                </ul>
              </td>
            </tr>
            <tr class="">
              <td data-label="Object" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e63 ">Contact Point Phone</td>
              <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e65 ">
                <ul>
                  <li>Parent</li>
                  <li>Phone Type</li>
                  <li>Active To Date</li>
                  <li>Active From Date</li>
                  <li>Area Code</li>
                  <li>Telephone Number</li>
                  <li>Name</li>
                </ul>
              </td>
            </tr>
            <tr class="">
              <td data-label="Object" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e63 ">Contact Point Type Consent</td>
              <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e65 ">
                <ul>
                  <li>Data Use Purpose</li>
                  <li>Double Consent Capture Date</li>
                  <li>Privacy Consent Status</li>
                  <li>Capture Source</li>
                  <li>Capture Contact Point Type</li>
                  <li>Email</li>
                  <li>Effective From</li>
                  <li>Capture Date</li>
                  <li>Contact Point Type</li>
                  <li>Effective To Date</li>
                  <li>Name</li>
                  <li>Engagement Channel Type</li>
                </ul>
              </td>
            </tr>
            <tr class="">
              <td data-label="Object" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e63 ">Communication Subscription Consent</td>
              <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e65 ">
                <ul>
                  <li>Consent Captured Source</li>
                  <li>Contact Point</li>
                  <li>Effective From Date</li>
                  <li>Effective To Date</li>
                  <li>Consent Captured DateTime</li>
                  <li>Consent Giver</li>
                  <li>Name</li>
                  <li>Comm Subscription Channel Type</li>
                </ul>
              </td>
            </tr>
            <tr class="">
              <td data-label="Object" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e63 ">Individual</td>
              <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e65 ">
                <ul>
                  <li>Name</li>
                  <li>Block Geolocation Tracking</li>
                  <li>Don’t Process</li>
                  <li>Don’t Profile</li>
                  <li>Don’t Market</li>
                  <li>Don’t Track</li>
                  <li>OK to Store PII Data Elsewhere</li>
                  <li>Forget this Individual</li>
                  <li>Export Individual’s Data</li>
                </ul>
              </td>
            </tr>
            <tr class="">
              <td data-label="Object" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e63 ">Lead</td>
              <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e65 ">
                <ul>
                  <li>Email</li>
                  <li>Do Not Call</li>
                  <li>Address</li>
                  <li>Phone</li>
                  <li>Has Opted Out Of Email</li>
                  <li>Has Opted Out Of Fax</li>
                  <li>Mobile Phone</li>
                  <li>Individual </li>
                </ul>
              </td>
            </tr>
            <tr class="">
              <td data-label="Object" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e63 ">Party Consent</td>
              <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e65 ">
                <ul>
                  <li>Action</li>
                  <li>Party</li>
                  <li>Double Consent Capture Date</li>
                  <li>Privacy Consent Status</li>
                  <li>Capture Source</li>
                  <li>Capture Contact Point Type</li>
                  <li>Phone</li>
                  <li>Effective From</li>
                  <li>Capture Date</li>
                  <li>Effective To</li>
                  <li>Name</li>
                </ul>
              </td>
            </tr>
            <tr class="">
              <td data-label="Object" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e63 ">Person Account</td>
              <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e65 ">
                <ul>
                  <li>Person Home Phone</li>
                  <li>Person Do Not Call</li>
                  <li>Person Has Opted Out Of Fax</li>
                  <li>Person Mailing Address</li>
                  <li>Phone</li>
                  <li>Person Mobile Phone</li>
                  <li>Person Individual</li>
                  <li>Person Other Phone</li>
                  <li>Person Assistant Phone</li>
                  <li>Person Email</li>
                  <li>Person Has Opted Out Of Email</li>
                  <li>Person Other Address</li>
                </ul>
              </td>
            </tr>
            <tr class="">
              <td data-label="Object" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e63 ">User</td>
              <td data-label="Field" class="slds-cell-wrap" style="vertical-align:top;" headers="d11370e65 ">
                <ul>
                  <li>Email</li>
                  <li>Address</li>
                  <li>Phone</li>
                  <li>Mobile Phone</li>
                  <li>Individual</li>
                </ul>
              </td>
            </tr>
          </tbody>
        </table>

1. From Setup, in the Quick Find Box, enter Consent Event Stream, and then select **Consent Event Stream**.
2. Select **Use the consent event stream**.
3. Subscribe to the channel /event/ConsentEvent. For more information, see [Subscribing to Platform Events](https://developer.salesforce.com/docs/atlas.en-us.platform_events.meta/platform_events/platform_events_subscribe.htm)

![Example](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-data_protection_and_privacy-264-0-0-production-enus/27d1bf87-a47b-491a-8339-f53ef6540aec/images/icon_example.png)

Example channel /event/ConsentEvent

```java

{
  “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”
}
```