Change Data Capture Developer Guide

Change Data Capture
Keep Your External Data Current with Change Data Capture
When Do You Use Change Data Capture?
Change Event Object Support
Select Objects for Change Notifications in the User Interface
Select Objects for Change Notifications with Metadata API and Tooling API
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
Change Event Considerations
Standard Object Notes
Change Events for Fields
PDF

Select Objects for Change Notifications with Metadata API and Tooling API

Use PlatformEventChannelMember in Metadata API or Tooling API to create or retrieve object event selections for the default standard channel or a custom channel. The default standard channel, ChangeEvents, corresponds to the selections that you configure in Setup in the Change Data Capture page. For a custom channel, the selections are set when you create the channel member. The SelectedEntity field in PlatformEventChannelMember represents a selected event.

Selections made in PlatformEventChannelMember for a custom channel aren’t reflected in the Change Data Capture page. The Change Data Capture page shows selections only for the default standard channel, ChangeEvents, and not for custom channels. To find out which entities are selected for custom channels, perform a SOQL query on PlatformEventChannelMember in Tooling API.

Note

To learn how to select objects with Metadata API, see PlatformEventChannelMember in the Metadata API Developer Guide.

To learn how to select objects with Tooling API, see PlatformEventChannelMember in the Tooling API Developer Guide.

To learn about custom channels, see Compose Streams of Change Data Capture Notifications with Custom Channels, PlatformEventChannel in the Metadata API Developer Guide, and PlatformEventChannel in the Tooling API Developer Guide.

Starting with API version 47.0, you define channel member components and channels separately in Metadata API. In API version 45.0 and 46.0, members are included in the PlatformEventChannel component.