EnrichedField

Represents a field selected for Change Data Capture Enrichment for a channel and channel member. A non-empty enriched field is added to an update or delete change event even when not changed.

As a beta feature, Change Data Capture Enrichment is a preview and isn’t part of the “Services” under your master subscription agreement with Salesforce. Use this feature at your sole discretion, and make your purchase decisions only on the basis of generally available products and features. Salesforce doesn’t guarantee general availability of this feature within any particular time frame or at all, and we can discontinue it at any time. This feature is for evaluation purposes only, not for production use. It’s offered as is and isn’t supported, and Salesforce has no liability for any harm or damage arising out of or in connection with it. All restrictions, Salesforce reservation of rights, obligations concerning the Services, and terms for related Non-Salesforce Applications and Content apply equally to your use of this feature. You can provide feedback and suggestions for Change Data Capture Enrichment in the Trailblazer Community. For information on enabling this feature in your org, contact Salesforce.

Note

Supported SOAP API Calls

delete(), describeSObjects(), query(), retrieve()

Supported REST API HTTP Methods

DELETE, GET, HEAD, Query

Special Access Rules

This object is part of Change Data Capture Enrichment, which is a beta feature. To enable the feature and access this object, contact Salesforce.
Use the EnrichedField object to query, retrieve, or delete enriched fields. Add an enriched field as part of PlatformEventChannelMember. For more information about Change Data Capture Enrichment and adding enriched fields, see Enrich Change Events with Extra Fields When Subscribed with CometD and Example: Add Event Enrichment Fields with Tooling API in the Change Data Capture Developer Guide.
To retrieve or query this object, you must have the View Setup and Configuration permission.
To delete this object, you must have the Customize Application permission.

Fields

Field	Details
ChannelMemberId	Type reference Properties Create, Filter, Group, Sort Description The ID of the PlatformEventChannelMember that this field is part of. For example, if a field is added to the AccountChangeEvent, which is part of PlatformEventChannelMember, ChannelMemberId is the ID of the PlatformEventChannelMember record.
Field	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The name of the field to enrich change events with. For a list of supported field types, see Enrich Change Events with Extra Fields When Subscribed with CometD (Beta) in the Change Data Capture Developer Guide.
ManageableState	Type ManageableState enumerated list Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package: `beta` `deleted` `deprecated` `deprecatedEditable` `installed` `installedEditable` `released` `unmanaged`

Usage

To find out which channel members and fields you configured, query the EnrichedField object. For example, this query returns the channel member ID and the selected enriched field on that channel.

1SELECT ChannelMemberId,Field FROM EnrichedField ORDER BY ChannelMemberId

In these query results, the rows returned are ordered by the channel member ID. The first two rows contain two enriched fields on the same channel: the Industry field and a custom field, whose value is an ID. The last row is for a different channel member and contains the Phone enriched field.

ChannelMemberId	Field
0v8RM00000000JsYAI	Industry
0v8RM00000000JsYAI	00NRM000001gEx32AE
0v8RM00000000fIYAQ	Phone