Setting up a Custom Event takes you to the Event Builder, where you can create the event with a custom payload. Once the custom event is used in the pipeline, it allows you to manually trigger your pipeline whenever needed and specify unique values for each run, instead of waiting for the event to occur.

You can access your custom events via the Events tab located in the top-left corner, in Orchestrate.

Create an event

1. In the Events tab, click + New Event.
2. Enter the event name to display in the lists.
3. Click + Add Key to define keys, or click Save to create the event with an empty payload.
4. Enter the key name, which will appear in the form when running the pipeline. Details are available here.
5. Select the value type (Location picker, Text, or Numeric) to determine how the value will be input in the form during manual pipeline runs. Details are available here.
6. Configure the key properties as needed.
7. Repeat steps 3–6 to add as many keys as required.
8. Click Save. The event will now be available for use in pipelines within the team.

📘

You can define up to 20 keys per event.

Event builder

In the Event Builder, you design the event with a custom payload using a variety of available value types. The builder also allows you to preview the keys and their configurations in the canvas you've added to your event.

Canvas

The canvas is the main area where the current state of the configured key-value pairs is dynamically displayed as non-editable widgets. It reflects the inputted value types for keys and associated configurations from the right panel. In this area, you can add new keys, view the configured values for each key, and manage the order of key-value pairs.

General properties

You can add up to 20 keys to your event, each requiring a unique key name and value type. The following value types are available in the Event Builder:

This value type is represented by two dropdowns—Projects and Folders. When selected for a key, it appears in the form during a manual pipeline run, allowing users to specify values through these dropdown menus.

You can modify the following properties for each dropdown separately:

• Single-select / Multi-select: This option defines whether the Projects or Folders dropdown in the form (when running the pipeline) is single-select or multi-select.
• Required Checkbox: This option allows you to specify whether the Projects or Folders dropdown in the form (when running the pipeline) is mandatory.

This value type is represented by a text input. When selected for a key, it appears in the form during a manual pipeline run, allowing users to enter the value as text.

This value type is represented by a numeric input. When selected for a key, it appears in the form during a manual pipeline run, allowing users to enter the value as a number.

Example custom event JSON

{
    "Source": [				// Location picker
      {
        "name": "Project A",
        "id": 123,
        "folders": [
          { "name": "Folder A", "id": 1 },
          { "name": "Folder B", "id": 2 }
        ]
      },
      {
        "name": "Project C",
        "id": 234,
        "folders": null
      }
    ],
    "Destination folder": "Test",	// Text
    "Performance score": 5		// Numeric