CreateShortcutBody

Body for Create Shortcut. `workflow_id`, `name` and `outputs` are required; the input schema is read from the workflow's input columns.

Properties

workflow_idstringrequired

UUID of the workflow to package. It must belong to your organization and have at least one named input column.

namestringrequiredminLen 1

Shortcut display name.

descriptionstring

What the shortcut does, shown in the Gallery and returned by Get Shortcut.

icon_emojistring

Emoji used as the shortcut icon. Defaults to 🚀.

outputsarray ofrequired

The fields a run returns, in order. Each item names one output field and points it at a value: a `{{input.<field>}}` or `{{<action_instance_id>.<field>}}` reference, a literal, or a mix. Written onto the workflow's `output_shortcut` action (added to the end of the chain when there is none) and returned as `output_schema`. An output keeps its identity across updates as long as its `name` is unchanged. A reference nothing produces is kept and reported in `warnings`.

namestringrequiredminLen 1

Output field name — the key its value appears under in a run's `output_data`.

valuestringrequired

Where the value comes from.

Example

CreateShortcutBody example

{
  "workflow_id": "531952c2-3d07-4be2-8c4b-733acba3187b",
  "name": "Company Enrichment",
  "description": "Enriches company data from a LinkedIn URL",
  "icon_emoji": "🏢",
  "outputs": [
    {
      "name": "Company Website",
      "value": "{{enrich_company_linkedin_profile_1.company_website}}"
    },
    {
      "name": "Employee Count",
      "value": "{{enrich_company_linkedin_profile_1.employee_count}}"
    }
  ]
}