Create a Channel for a Change Event

Create a channel that holds a stream of change data capture events.

Required Editions

User Permissions Needed
To create a PlatformEventChannel: Customize Application
  1. Send a POST request to this URI.
    /services/data/v65.0/tooling/sobjects/PlatformEventChannel
  2. If you’re using Postman, expand Event Platform | Custom Channels | Platform Event, and click Create channel.
  3. To configure a channel that receives change event messages, set channelType to data. The channel label appears in the event relays UI. Use this example request body. In Postman, click Body, and replace the body with this JSON body.
    {
      "FullName": "Account_Channel__chn",
      "Metadata": {
         "channelType": "data",
         "label": "Account Channel"
     }
    }
  4. Send the request. The response received looks similar to this response.
    {
      "id": "0YLRM00000001fR4AQ",
      "success": true,
      "errors": [],
      "warnings": [],
      "infos": []
    }

Now that you created a channel for change events, add a channel member for one change event. See Add a Change Event in a New Channel Member.