When a platform event step executes, a platform event is triggered. You can specify whether the system listens or not. The system may listen for a return message for a platform event. If not, the process moves on.

If you already have steps in the definition, you can either use the New Child link next to the step name while viewing the definition or you can use the New Child Step button while viewing the existing Step (towards the bottom of the page).

To create a step with platform event

  1. Navigate to the definition where you will place this step.
  2. In the Steps section of the screen, click the New Step button. The Step Edit page appears.
  3. In the General Information section, fill in the following fields:
    • Step Name - Enter a name for the step. This field is copied into the subject when the process executes.
    • Step Type - Select Platform Event.
    • Parent Step - Use Lookup to define the parent step, which is the step that must be completed before the Create Record step is initiated.
      • Leave the field blank if the Create Record step requires initiation as soon as the process starts.
    • Parent Stage - If a parent step is part of a parent stage, all of the steps in the stage must complete before the Create Record step is created.
    • Stage - Use Lookup to select the stage to associate with the Create Record step, if applicable.
    • Definition - The field is automatically populated based on the selected definition.
  4. In the Publish Event Setting section, set the values of the platform event that will be created when this step executes.
    • From the Find an Object picklist, select an object type. For example, Orchestrate Event. 

    • Configure the values for the Event field to be set when the event is published.

      • You can now set the fields on the selected object. For example, Event Number.
      • From the Type column, select one of the following:
        • Number 
        • Reference  
      • If you select Type = Number, in the Value column, enter a value for the selected field. In case of Event Number it must always be 9.
        If Type = Reference, you must select the business process and the object/field to be used for the event.

  5. In the Subscribe Event Setting section, you can set completion conditions. The step remains open until a subsequent platform event has been subscribed, too.

    For Subscribe, you must first create a platform event trigger and call the SubscribeEventSrvc.processSubscribeEventRecords(List<SObject> events) class.


    • From the Find An Object picklist, select an object type. For example, Orchestrate Event. 

    • Configure Event field values to set when the event is published.

      • You can now set the fields on the selected object. For example, Event Number.
      • From the Type column, select one of the following:
        • Number 
        • Reference  
      • If you select Type = Number, in the Value column, enter a value for the selected field. In case of Event Number it must always be 9.
        If Type = Reference, you must select the business process and the object/field to be used for the event.
  6. Click Save.

When a platform event step is configured, at that point in the process the event is published with all fields populated as configured on the step. If a flow or process builder is subscribed to this event, it fires just after Orchestrate publishes the event. After the flow or process builder publishes the event, Orchestrate listens for this event and continues the Orchestrate process.