Workflows

Create workflow

Create a workflow with only its Input step, as the builder's New workflow does: its other steps are saved in its draft once it exists (PATCH /draft), which sets up their triggers. A document refused leaves no workflow behind.

post/v1/workspaces/{workspace_id}/workflows

Request

  • Base URL
    https://api.stacksync.com
  • URL
    https://api.stacksync.com/v1/workspaces/{workspace_id}/workflows
  • Auth
    HTTP bearer

Path parameters

workspace_idinteger required

The workspace. List the ones your key can reach with GET /v1/workspaces.

Query parameters

region'besg' | 'usnv' required

Region of the resource: besg (Europe) or usnv (United States), as GET /v1/regions lists them

Headers

Idempotency-Keystring nullable

Makes the create retry-safe for 24 hours: a retry with the same key answers the resource the first call created, with the Idempotent-Replayed: true header, and creates nothing. 1 to 255 visible ASCII characters. The same key with a different request answers 422; while the first call still runs, 409.

Request body

workflow_namestring required
workflow_resource_idstring nullable

A human-readable id, unique in the workspace (lowercase letters, digits and _, at most 60); derived from the name when absent

folder_idstring nullable

The folder to create it in; the root when absent

is_shared_with_workspaceboolean nullable
validate_onlyboolean

Run every check of the write and answer 204 without writing: a refused write answers the error the write would

Response

Created

workflow_idstring required
workflow_namestring required
region'besg' | 'usnv' required

Changes

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