Sign in
workflows

Create Workflow

Create a new workflow, either custom or auto, and configure its settings.

post/api/v1/workflows/

Headers

unstructured-api-keystring nullable

Request body

namestring required
workflow_type'basic' | 'advanced' | 'platinum' | 'custom' required
template_idstring nullable
schedule'every 15 minutes' | 'every hour' | 'every 2 hours' | 'every 4 hours' | 'every 6 hours' | 'every 8 hours' | 'every 10 hours' | 'every 12 hours' | 'daily' | 'weekly' | 'monthly' nullable
reprocess_allboolean nullable
skip_preflightboolean nullable

Skip the job preflight check for this workflow. Preflight runs by default.

keystring nullable

Stable workspace level identifier for the workflow. If omitted, derived from name. Immutable once set. 1-63 characters, lowercase alphanumeric and hyphens, no consecutive/leading/trailing hyphens.

Example request

{
  "key": "invoice-processing-v2"
}

Response

Successful Response

idstring uuid required
namestring required
keystring nullable
sourcesstring[] required
destinationsstring[] required
workflow_type'basic' | 'advanced' | 'platinum' | 'custom'
status'active' | 'inactive' required
created_atstring date-time required
updated_atstring date-time nullable
reprocess_allboolean
skip_preflightboolean

Example response

{
  "schedule": {
    "crontab_entries": [
      {
        "cron_expression": "0 0 * * *"
      }
    ]
  }
}

Changes

Changed in 1 of the 3 revisions of this API.2

  • ccebd049e0122See the full diff
    • ○

      added the new optional request property skip_preflight

      new-optional-request-property

    • ○

      added the optional property skip_preflight to the response with the 200 status

      response-optional-property-added