Pipeline schedule object

created_at
string
required

Date and time the trigger was created.

event_matchers
array of objects

Event matching logic for event triggers.

id
integer
required

Trigger ID.

last_pipeline_run_status
string
name
string
required

Name of trigger.

pipeline_runs_count
integer
pipeline_uuid
string
required

Pipeline UUID the trigger belongs to.

schedule_interval
string

@once, @hourly, @daily, @weekly, @monthly

schedule_type
string
required

Trigger type: api, event, time

settings
object

Additional settings for the trigger.

allow_blocks_to_fail
boolean

If true, then blocks in the pipeline will continue to run even if unrelated blocks fail.

create_initial_pipeline_run
boolean

If true, then an initial pipeline run will be created immediately after enabling the trigger if the trigger’s current execution date is after its start date time but before current time.

For example, if the current time is 1/4/24 12:00 UTC and you create a daily trigger, the current execution date would be 2024-01-04 00:00. If the start date was set to 1/3/24 12:00 UTC, which is before the current execution date, and the create_initial_pipeline_run setting was enabled, a pipeline run with execution date 2024-01-04 00:00 would get created immediately.

skip_if_previous_running
boolean

If true, then new pipeline runs won’t be triggered until the most recent pipeline run is no longer running.

sla
integer

If the pipeline run has been running for more than the SLA value, then the pipeline will fail.

start_time
datetime

Date and time when the trigger should start running.

status
string
required

active, inactive

tags
array

An array of tag names.

token
string

Unique string used in the URL when triggering pipeline via API request.

updated_at
datetime
required

Date and time the trigger was last updated.

variables
object

Object containing variables for the pipeline that is being overwritten by this trigger.

[key]
string

The property name is user defined.