BackgroundJob

Job of the instance waiting in the background queue (scheduled, waiting for a
retry, dead) or currently running, for example one scheduled with the background tag

type BackgroundJob {
  arguments: JSONPayload
  attempts: Int
  created_at: JSONDate!
  dead_at: JSONDate
  error: String
  error_class: String
  error_message: String
  failed_at: JSONDate
  form_configuration_name: String
  form_name: String
  id: ID!
  label: String
  liquid_body: JSONPayload
  locked_at: JSONDate
  partial_name: String
  queue: String!
  resource_id: ID
  resource_type: String
  retry_at: JSONDate
  run_at: JSONDate
  source_name: String
  source_type: String
  started_at: JSONDate
  updated_at: JSONDate
}

Fields

arguments (JSONPayload)

Variables passed to the background tag, available to the job code; empty object for other jobs

attempts (Int)

Number of retries allowed for the job, as set with the max_attempts option of
the background tag. 0 (the default) means a failed job is not retried

created_at (JSONDate)

Timestamp of when the job was scheduled

dead_at (JSONDate)

Timestamp of when the job was declared dead after using up its retries; set only for dead jobs

error (String)

Deprecated, always null; use error_message instead

error_class (String)

Name of the error type of the last failure

error_message (String)

Error message of the last failure

failed_at (JSONDate)

Timestamp of when the job last failed; null if it has not failed

form_configuration_name (String)

Deprecated, always null

form_name (String)

Deprecated, always null

id (ID)

Unique identifier of the job, as returned by the background tag

label (String)

Deprecated, always null; use source_name instead

liquid_body (JSONPayload)

Liquid code to run, for a job scheduled with the block form of the background tag

locked_at (JSONDate)

Deprecated, always null

partial_name (String)

Path of the partial to run, for a job scheduled with the partial form of the background tag

queue (String)

Queue the job is waiting in, which follows its priority: high, default or low

resource_id (ID)

Deprecated, always null

resource_type (String)

Deprecated, always null

retry_at (JSONDate)

Timestamp of when a failed job will be retried; set only for jobs waiting for a retry

run_at (JSONDate)

Timestamp of when the job is scheduled to run, or for a running job when it started

source_name (String)

Label given to the job with the source_name option of the background tag

source_type (String)

Deprecated, always null

started_at (JSONDate)

Timestamp of when the job started running; set only for running jobs

updated_at (JSONDate)

Deprecated, always null