Pipelines can be imported and exported in JSON format. This reference provides detail of the JSON document structure.

Pipeline

Defines a CRMint pipeline. This is the root object of a document for import.

Property	Type	Required	Description
name	string	True	The name of the pipeline.
jobs	Job[]	False	A list of Job nodes which make up the execution graph of the pipeline.
params	Variable[]	True	A list of pipeline-level variables.
run_on_schedule	boolean	False	Whether the pipeline is scheduled
schedules	Schedule[]	True	A list of Schedule definitions, for automated pipeline execution.
emails_for_notifications	string	False	A whitespace-delimited string of email addresses

Job

Defines a single worker node in the execution graph.

Property	Type	Required	Description
id	string	True	An ID to uniquely identify this node in the execution graph, such as a UUID.
name	string	True	A name to describe the purpose of this Job node.
worker_class	string	True	The node type for this job, for example: BQQueryLauncher See Worker specification
params	Param[]	True	A list of job-level parameters.
hash_start_conditions	StartCondition[]	True	A list of conditions for the job node to start execution, for example, successful execution of previous jobs in the graph. All must evaluate to true.

Variable

Defines a pipeline-level variable

Property	Type	Required	Description
name	string	True	The variable name.
type	string	True	The type. This should be set to text
value	string	True	The variable value.

Schedule

Defines a frequency for automated execution

Property	Type	Required	Description
cron	string	True	The cron specification

Param

A setting used as an input to a Job node.

Property	Type	Required	Description
name	string	True	The variable name.
type	string	True	The type. Valid options include: string sql number boolean
value	string	True	The variable value.
description	string	False	?
label	string	False	?
is_required	boolean	False	Whether the parameter is mandatory: Defaults to false.

StartCondition

Used to define the conditions under which a Job will start

Property	Type	Required	Description
preceding_job_id	string	True	The ID of the job on which this condition depends
condition	string	True	Possible values are: success fail whatever - implies outcome is not important but the job referred to by preceding_job_id must have executed.