Flex icon

Flex

Integrate with Flex API for task management

Actions17

Workflow → Start Workflow

AI-generated

Summary

Start a new workflow process by selecting a workflow template and providing required metadata, title, description, deadline, responsible user, linked item, and optional file attachments.

Inputs

  • templateId (required) — Select a workflow template by name or ID to start a new workflow.
  • title (required) — Enter the title for the new workflow instance.
  • description — Provide a description for the workflow instance.
  • deadline (required) — Specify the deadline date and time for the workflow completion.
  • responsibleUser (required) — Search and select the responsible user by username or user ID who will oversee the workflow.
  • linkedItemType (required) — Choose the type of the linked item, either 'Sub-Record' or 'Main Record'.
  • linkedItem (required) — Search or enter the ID of the linked item by identifier or numeric ID.
  • metadataFields (required) — Add all required metadata fields for the selected workflow template by choosing each field name and providing its corresponding value.
  • files — Optionally attach one or more files by specifying file name and base64-encoded file content.

Output shape

a JSON object with the API response for the started workflow instance

The operation returns the HTTP response JSON from the Flex API representing the newly started workflow. The node will throw an error if any required metadata fields as defined by the template are missing.

Links

Discussion