Change Data Capture Developer Guide

Change Data Capture
Keep Your External Data Current with Change Data Capture
Change Event Message Structure
Subscribe to Change Events
Security Considerations
Required Permissions for Subscription
Field-Level Security
Change Events for Encrypted Salesforce Data
Generate a Tenant Secret
Enable Encryption and Delivery of Change Events
Capturing Changes and Encrypting the Event Payload
Change Event Considerations
Standard Object Notes
Change Events for Fields
Other Types of Change Events: Gap and Overflow Events
PDF

Newer Version Available

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

Generate a Tenant Secret

Before enabling change events for encrypted data, generate an Event Bus tenant secret.

Prerequisites:


User Permissions Needed
To manage tenant secrets: Manage Encryption Keys

Only authorized users can generate tenant secrets from the Platform Encryption page. Ask your Salesforce admin to assign you the Manage Encryption Keys permission.

Steps:

  1. From Setup, in the Quick Find box, enter Platform Encryption, and then select Key Management.
  2. In the Choose Tenant Secret Type dropdown list, choose the Event Bus data type.
  3. Click Generate Tenant Secret.
    Generate a tenant secret in the Key Management page
Alternatively, you can generate a tenant secret through SOAP API or REST API using the TenantSecret object and the Type field value of EventBus.

For more information, see TenantSecret in the Object Reference for Salesforce and Force.com.