Skip Navigation
Developers
Developers
Platform Events Developer Guide
j
Spring '24 (API version 60.0)
Not Latest
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)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Newer Version Available
This content describes an older version of this product.
View Latest
Platform Events Developer Guide
/
Defining Your Custom Platform Event
Defining Your Custom Platform Event
Define a platform event in Setup and add custom fields.
Available in: both Salesforce Classic and Lightning Experience
Available in:
Performance
,
Unlimited
,
Enterprise
, and
Developer
Editions
User Permissions Needed
To create and edit platform event definitions:
Customize Application
Platform Event Fields
Platform events contain standard fields. Add custom fields for your custom data.
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 life cycle.
Get the Event Schema
To discover the event fields of your platform event, get the event schema. You can get the event schema through REST API or Pub/Sub API.