ActionInstance

An action instance in a workflow sheet's chain. Returned from Add Action and Get Action; contains enough information to subsequently call Configure Action (to wire inputs) or to wire downstream actions to this one (via `outputs[].reference`).

Properties

action_instance_idstringrequired

Unique ID of this action instance within the sheet. Use this value as the `after` param when inserting further actions, and as the path param on Configure / Delete endpoints.

action_idstringrequired

Action template identifier this instance was created from.

display_namestringrequired

User-facing name. Defaults to the action template's name; can be overridden per instance in the future.

inputsarray ofrequired

Input fields the caller must configure via Configure Action.

ActionInput

outputsarray ofrequired

Output fields this action produces when it runs. Each has a `reference` token for downstream wiring.

ActionOutput

Example

ActionInstance example

{
  "action_instance_id": "scrape_person_linkedin_profile_1",
  "action_id": "scrape_person_linkedin_profile",
  "display_name": "Scrape Person LinkedIn Profile",
  "inputs": [
    {
      "name": "linkedin_url",
      "type": "url",
      "required": false,
      "description": "LinkedIn profile URL of the person"
    }
  ],
  "outputs": [
    {
      "name": "full_name",
      "type": "string",
      "reference": "{{enrich_person_linkedin_profile_1.full_name}}",
      "description": "Work history as JSON. Each item: title, company, start_date, end_date, summary, url, company_domain, company_identifier",
      "columns": [
        {
          "name": "string",
          "type": "string",
          "structured_array_reference": "{{raw_to_structured_array_1.list.first_name}}"
        }
      ]
    }
  ]
}