Platform Events (Beta) Developer Guide
jNewer Version Available
Migrate Platform Event Definitions with Metadata API
Deploy and retrieve platform event definitions from your sandbox and production org as
part of your app’s development lifecycle.
The CustomObject metadata type represents platform events.
Platform event names are appended with __e. The file that contains the platform event definition has the suffix .object. Platform events are stored in the objects folder.
Here is a definition of a sample platform event with one text field.
1<?xml version="1.0" encoding="UTF-8"?>
2<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
3 <deploymentStatus>Deployed</deploymentStatus>
4 <fields>
5 <fullName>DemoTextField__c</fullName>
6 <externalId>false</externalId>
7 <isFilteringDisabled>false</isFilteringDisabled>
8 <isNameField>false</isNameField>
9 <isSortingDisabled>false</isSortingDisabled>
10 <label>DemoTextField</label>
11 <length>16</length>
12 <required>false</required>
13 <type>Text</type>
14 <unique>false</unique>
15 </fields>
16 <label>DemoPlatformEvent</label>
17 <pluralLabel>DemoPlatformEvents</pluralLabel>
18</CustomObject>This package.xml manifest file references the previous event definition. The name of the referenced event is DemoPlatformEvent__e.
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>DemoPlatformEvent__e</members>
5 <name>CustomObject</name>
6 </types>
7 <version>39.0</version>
8</Package>