Change Data Capture Developer Guide

Change Data Capture
Keep Your External Data Current with Change Data Capture
Change Event Message Structure
Merged Change Events
Other Types of Change Events: Gap and Overflow Events
Subscribe to Change Events
Monitor Change Event Publishing and Delivery Usage
Security Considerations
Required Permissions for Change Events Received by CometD and Pub/Sub API Subscribers
Field-Level Security
Change Events for Encrypted Salesforce Data
Generate a Tenant Secret
Enable Encryption of Change Events
Capturing Changes and Encrypting the Event Payload
Change Event Considerations
Standard Object Notes
Change Events for Fields
PDF

Newer Version Available

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

Generate a Tenant Secret

To enable encryption of change events, first 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 the Manage Encryption Keys permission to you.

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 Event Bus.
  3. Click Generate Tenant Secret or, to upload a customer-supplied tenant secret, click Bring Your Own Key.
    Generate a tenant secret in the Key Management page
  • If your Salesforce org has no tenant secrets, perform Step 3 before Step 2.
  • You can generate or rotate an event bus tenant secret once every 7 days.
  • You can also 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 Lightning Platform.

Note