Shortcut

A shortcut wraps a workflow with typed input/output schemas, providing a simplified interface for running workflows programmatically. Shortcuts can be shared across an organization.

Properties

idstring

Unique shortcut identifier (UUID)

workflow_idstring

UUID of the underlying workflow that powers this shortcut

parent_app_idstring (nullable)

If this is a shared copy, the ID of the original master shortcut. Null for master shortcuts.

floqer_catalog_idstring

Global identity when this shortcut is shared across organizations.

call_shortcut_idstring

Source shortcut ID accepted by a Call Shortcut workflow action.

floqer_source_versioninteger

Current published source version for a global shortcut.

is_virtualboolean

Whether this shortcut is a read-only projection.

namestring

Shortcut display name

descriptionstring

Human-readable description of what the shortcut does

creator_emailstring

Email of the user who created the shortcut

org_idstring

Organization ID the shortcut belongs to

visibilitystring (nullable)

Get Shortcut only. `org`: everyone in the organization can use it. `private`: its creator and the people it is shared with. Null for a shortcut published before versioning.

shared_usersarray of

Get Shortcut only. Emails it is shared with (use access). Populated for the shortcut's creator; otherwise `[]`.

string

input_schemaarray of

Ordered list of input fields — derived from the workflow's input action (id1)

InputField

output_schemaarray of

Ordered list of output fields — derived from the workflow's OUTPUT_CUSTOM_ENRICHMENT action

OutputConfig

is_masterboolean

True if this is the original shortcut (not a shared copy)

is_publishedboolean

Whether the shortcut is published and available for runs

is_archivedboolean

Whether the shortcut has been archived

callableboolean

Whether a workflow can call this shortcut: set its `id` as `shortcut` on a `call_shortcut` action. False until the shortcut has a published version; republish it in the Floqer app.

extensionsobject

Browser extensions that can trigger this shortcut, each with the input (by `reference`) it fills from the page. `{}` when none can. A `null` input means that extension is on but its input is no longer on the shortcut, so it fills nothing: set a new input or turn it off.

linkedinstring (nullable)

The input the LinkedIn extension fills from the profile page, by its `reference`.

sales_navigatorstring (nullable)

The input the Sales Navigator extension fills from the page, by its `reference`.

cover_imagestring (nullable)

URL of the shortcut's cover image

icon_emojistring (nullable)

Emoji used as the shortcut icon

created_atstring <date-time>

When the shortcut was created

updated_atstring <date-time>

When the shortcut was last updated

Example

Shortcut example

{
  "id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f9a",
  "workflow_id": "531952c2-3d07-4be2-8c4b-733acba3187b",
  "parent_app_id": "string",
  "floqer_catalog_id": "string",
  "call_shortcut_id": "string",
  "floqer_source_version": 0,
  "is_virtual": false,
  "name": "Company Enrichment",
  "description": "Enriches company data from a LinkedIn URL",
  "creator_email": "user@company.com",
  "org_id": "string",
  "visibility": "string",
  "shared_users": [
    "string"
  ],
  "input_schema": [
    {
      "reference": "linkedin_url",
      "name": "LinkedIn URL",
      "description": "Full LinkedIn company profile URL",
      "type": "text",
      "required": true,
      "defaultValue": null
    }
  ],
  "output_schema": [
    {
      "name": "Company Website",
      "description": "Main website URL of the company",
      "display_column": "Company Website"
    }
  ],
  "is_master": true,
  "is_published": true,
  "is_archived": false,
  "callable": true,
  "extensions": {
    "linkedin": "linkedin_url"
  },
  "cover_image": "string",
  "icon_emoji": "🏢",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z"
}