Skip to main content

JobQueueByJobEnvelope

okbooleanrequired

Possible values: [true]

request_idstringrequired
Example: req_01HXYZABC123
data objectrequired
tasks object[]required
  • Array [
  • idstringrequired
    jobstringrequired
    typestringrequired
    targetstringnullable
    options objectnullable
    property name*anynullable
    attemptsintegerrequired
    next_run_atdate-timerequired
    statusJobQueueStatusrequired

    Possible values: [pending, waiting, processing, completed, failed, canceled]

    created_atdate-timenullable
  • ]
  • property name*any
    JobQueueByJobEnvelope
    {
    "ok": true,
    "request_id": "req_01HXYZABC123",
    "data": {
    "tasks": [
    {
    "id": "string",
    "job": "string",
    "type": "string",
    "target": "string",
    "options": {},
    "attempts": 0,
    "next_run_at": "2024-07-29T15:51:28.071Z",
    "status": "pending",
    "created_at": "2024-07-29T15:51:28.071Z"
    }
    ]
    }
    }