Change Data Capture Developer Guide
Winter '27 (API version 68.0)
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
When Do You Use Change Data Capture?
Change Event Object Support
Select Objects for Change Notifications
Migrate Object Selections with Metadata API and Tooling API
Compose Streams of Change Data Capture Notifications with Custom Channels
Newer Version Available
Keep Your External Data Current with Change Data Capture
Use Change Data Capture to update data in an external system instead
of doing periodic exports and imports of data or repeated API calls. Capturing changes with
Change Data Capture event notifications ensures that your external data can be updated in real
time and stays fresh.
-
When Do You Use Change Data Capture?
You can think of Change Data Capture as part of the data replication process for the cloud. Data replication includes the following stages. -
Change Event Object Support
Change events are available for all custom objects defined in your Salesforce org and a subset of standard objects. Select the objects that you want to get notifications for on the Change Data Capture page in Setup. -
Select Objects for Change Notifications
To receive notifications for record changes, select the custom objects and supported standard objects that you are interested in. From Setup, enter Change Data Capture in the Quick Find box, and click Change Data Capture. -
Migrate Object Selections with Metadata API and Tooling API
Use the PlatformEventChannelMember metadata type to deploy or retrieve object event selections for the ChangeEvents standard channel. The ChangeEvents standard channel corresponds to the selections that you configure in Setup in the Change Data Capture page. In Tooling API, you can migrate object selections through the PlatformEventChannelMember objects. -
Compose Streams of Change Data Capture Notifications with Custom Channels
Subscribe to a custom channel to receive a stream of the types of events that your app consumes. For example, if you have an app that uses real-time information about sales objects (for example, Account, Contact, and Order), create a custom channel with these objects. When you subscribe to the custom channel, you receive notifications only for these objects.