Home
HomeGuidesRecipesAPI ReferencePython SDKAI Agent SDKAlation Data Quality SDKAlation's MCP Server
HomeAlation Help Center
API Reference
Alation Help Center

Create a scheduled workflow

post
{protocol}://{base-url}/ai/api/v1/workflow/schedules/

Create a new schedule for automatic workflow execution based on a cron expression

Body Params

Schema for creating a scheduled workflow.

uuid
required

UUID of the workflow to schedule

string
required
length between 1 and 255

Human-readable name for this schedule

Optional detailed description of what this schedule does

workflow_parameters
object

Parameters to pass to the workflow execution

array | null

Named parameter configurations for multi-config scheduling. When set, the schedule fires once per configuration.

object | null

Authentication credentials (refresh tokens, API keys)

UUID of auth_config for managed OAuth credentials

string
required
length between 9 and 50

Cron expression (e.g., '0 3 * * *' for 3 AM daily)

string
Defaults to UTC

IANA timezone for cron evaluation (e.g., 'America/New_York', 'UTC')

boolean
Defaults to true

Whether this schedule is active

string
enum
Defaults to forbid

How to handle overlapping executions: 'forbid', 'replace', or 'allow'

Allowed:
integer
1 to 1440
Defaults to 60

Maximum execution time in minutes before task is marked as failed

boolean
Defaults to true

Whether to send an email notification when this schedule's workflow fails

Responses

Updated 3 days ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 3 days ago

Did this page help you?