FLfloqer
Shortcuts

Create Shortcut

Packages a workflow as a shortcut and publishes its first version, in one call:

  • input_schema — the workflow's input columns (List Inputs). Every column becomes an input; its reference is the snake_cased column name.
  • output_schema — the outputs you send. Each item names one field a run returns and points it at a value, usually a {{...}} reference to an upstream action. They are written onto the workflow's output_shortcut action, which is added to the end of the chain when there is none.

Requirements (a 400 lists every unmet one in reasons): the workflow has at least one named input column, and at least one item in outputs. You must be able to edit the workflow. A workflow with one output_shortcut action per branch cannot be packaged here; use the Floqer app.

One shortcut per workflow: a second call returns 409. The created shortcut is published and runnable immediately — pass its id to Run Shortcut. To change its outputs or pick up new input columns later, call Update Shortcut; editing the workflow alone does not change the shortcut.

post/api/v1/shortcuts/

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Request body

workflow_idstring required

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

namestring required

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 🚀.

Example request

{
  "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}}"
    }
  ],
  "extensions": {
    "linkedin": "linkedin_url",
    "sales_navigator": "linkedin_url"
  }
}

Response

Default Response

statusinteger
messagestring

Example response

{
  "data": {
    "id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f9a",
    "workflow_id": "531952c2-3d07-4be2-8c4b-733acba3187b",
    "name": "Company Enrichment",
    "description": "Enriches company data from a LinkedIn URL",
    "creator_email": "user@company.com",
    "input_schema": [
      {
        "reference": "linkedin_url",
        "name": "LinkedIn URL",
        "description": "Full LinkedIn company profile URL",
        "type": "text",
        "required": true
      }
    ],
    "output_schema": [
      {
        "name": "Company Website",
        "description": "Main website URL of the company",
        "display_column": "Company Website"
      }
    ],
    "is_master": true,
    "is_published": true,
    "callable": true,
    "extensions": {
      "linkedin": "linkedin_url"
    },
    "icon_emoji": "🏢"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.