For Developers

Jobs Overview

A Job is a container for a set of tasks to be executed. A job must be created in order to run tasks.

Jobs do not contain any information about the work to be done; that is defined by the tasks associated with the job. Jobs primarily serve to group tasks for execution and tracking.

Processing Behavior

Jobs are processed in parallel across different integrations. This ensures that a large backlog of jobs in one integration will not block or delay the processing of jobs in another integration.

However, jobs within the same integration are processed sequentially. Only one job per integration can be in the working state at a given time.

Properties

PropertyTypeDescription
idstringThe UUID for the object.
created_dateDateWhen the job was created.
updated_dateDateWhen the job was updated.
stateJob StateThe state of the job.
propertiesObjectProperties associated with job.
integration_idstringThe integration id associated of the job.
link_idstringThe link id associated with the job.

JSON Example

{
    "id": "00000000-0000-0000-0000-000000000000",
    "created_date": "2022-10-24T17:07:33.987Z",
    "updated_date": "2022-10-24T17:12:01.242Z",
    "heartbeat_date": "2022-10-24T17:07:33.987Z",
    "state": "queued",
    "properties": {},
    "integration_id": "00000000-0000-0000-0000-000000000000",
    "link_id": null
}