Configure Start and End Events

The start and end events of a workflow define how a workflow starts and ends.

A Start event defines the start of the workflow. It allows you to specify input arguments in JSON that triggers the workflow so that the workflow starts executing its defined activities.

An End event marks the completion of a workflow. It can be configured to return a JSON response when the workflow completes.

About Start and End Events

  • You must configure payloads for the start and end events. Otherwise, the workflow validation fails.
  • You must configure mappings for all end events. Otherwise, the workflow validation fails.
  • For workflows with multiple end events, configure the payload for any one end event. The payload is automatically copied to the remaining end events.

Topics:

Configure a Start Event

  1. Select the Start event in your workflow.
  2. Open the Edit start pane using one of the following options:
    • Select the start event and click Edit start icon on the side of the canvas.
    • Select the start event, click Actions Actions icon and then select Configure.
  3. Enter the name of the start event in the Name field.
  4. Provide additional information in the Description field.
  5. In the Define input payload section, select the input payload source.
    1. If you selected JSON Editor, paste the JSON payload inline in the Payload section.

      The image shows a right-side pane titled “Edit start” for a “Start event". It includes a Name field with the value "Start event" and Description field which is empty.It contains a The image shows a right-side pane titled “Edit start” for a “Start event.”The image shows a right-side pane titled “Edit start” for a “Start event.” It contains fields Name and Description. In the section Define input payload, there is a drop-down field labeled "Select input payload source" that is set to JSON Editor. A Payload code editor contains a small JSON template.

    2. If you selected JSON File, drag and drop a JSON file in the Payload section.

      The image shows a right-side pane titled “Edit start” for a “Start event". It includes a Name field with the value "Start event" and Description field which is empty.It contains a The image shows a right-side pane titled “Edit start” for a “Start event.”The image shows a right-side pane titled “Edit start” for a “Start event.” It contains fields Name and Description. In the section Define input payload, there is a drop-down field labeled "Select input payload source" that is set to JSON File. Under Payload, there is a field where you can select or drop a JSON file. The maximum file size is specified as 100KB.

  6. Close the Edit start pane to save the changes.

Configure an End Event

  1. Select an End event in your workflow.
  2. Open the Edit end pane using one of the following options:
    • Select the end event and click Edit start icon on the side of the canvas.
    • Select the end event, click ActionsActions icon and then select Configure.
  3. Enter the name of the end event in the Name field.
  4. Provide additional information in the Description field.
  5. Either drag and drop a JSON file or paste the JSON payload inline in the editor to configure the response payload.

    Typically in the context of agentic AI, the response payload is sent as a callback request to an AI agent, based on which the AI agent performs the required action.

    Note:

    The callback URL is provided by the AI agent at runtime and cannot be configured within the workflow. If the workflow is not invoked through an AI agent, a callback request is not made.
  6. Close the End event pane to save the changes.

Complete configurations for the end event by mapping data. You can reuse mappings by copying them from one end event to another within the same workflow. See the following: