For Developers

Tasks Overview

A Task is an operation and its associated data that should be executed at a future point in time.

Tasks are associated with a job. They are the operations that will be executed when the job is activated. Tasks are executed in the order they are listed in the job.

The currently supported task entity types are:

Properties

PropertyTypeDescription
idstringThe UUID for the object.
created_dateDateWhen the task was created.
updated_dateDateWhen the task was udpated.
entity_typeTask Entity TypeThe entity type associated with the task
event_typeEvent TypeThe event type of the task.
stateTask StateThe state of the task.
attemptsnumberThe number of attempts made to execute the task.
propertiesObjectProperties associated with task.
job_idstringThe id of the job associated with the task.
integration_idstringThe id of the integration associated with the task.
dataObjectThe data required for the task.

JSON Example

{
    "id": "00000000-0000-0000-0000-000000000000",
    "created_date": "2022-10-21T20:50:25.634Z",
    "updated_date": "2022-10-21T20:50:25.634Z",
    "entity_type": "assignment",
    "event_type": "created",
    "state": "queued",
    "attempts": 0,
    "properties": {},
    "job_id": "00000000-0000-0000-0000-000000000000",
    "integration_id": "00000000-0000-0000-0000-000000000000",
    "data": {}
}