Skip to main content

Job Payload

The Job Payload consists of the "functional" part of the job, and is broken into two parts. The Elements, which are the job tasks, and the Connections, which defines what sequence to process the tasks in.

NameTypeDescription
elementsarrayAn array defining the various job elements. Each element object has a uid that uniquely identifies it, a kind that specifies the type of object, a task object that defines the generic task behavior, and a payload.
connectionsarrayAn array defining how the various task elements are connected.

Job Payload Example

{
"name": "My Job Name",
"payload": {
"elements": [
{
"uid": "source_file",
"kind": "source",
"payload":{
/* source payload */
}
},
{
"uid": "transcode_task",
"kind": "transcode",
"task": {
"retry_method": "fail"
},
"payload": {
/* transcode task payload */
}
}
],
"connections": [
{
"from": [
{
"element": "source_file"
}
],
"to": {
"success": [
{
"element": "transcode_task"
}
]
}
}
]
}
}