Example: Add Event Enrichment Fields with Metadata API

To add event enrichment fields, use the PlatformEventChannelMember metadata type.

This PlatformEventChannelMember component adds two enriched fields for AccountChangeEvent on the ChangeEvents standard channel.

1<?xml version="1.0" encoding="UTF-8"?>
2<PlatformEventChannelMember xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enrichedFields>
4        <name>External_Account_ID__c</name>
5    </enrichedFields>
6    <enrichedFields>
7        <name>Industry</name>
8    </enrichedFields>
9    <eventChannel>ChangeEvents</eventChannel>
10    <selectedEntity>AccountChangeEvent</selectedEntity>
11</PlatformEventChannelMember>

Use this package.xml manifest file to deploy or retrieve the channel member definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>ChangeEvents_AccountChangeEvent</members>
5        <name>PlatformEventChannelMember</name>
6    </types>
7    <version>47.0</version>
8</Package>

Change Data Capture Developer Guide

Example: Add Event Enrichment Fields with Metadata API