Homepage

BackgroundJob

Last edit: Oct 26, 2022

Background Job

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
  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)

attempts (Int)

how many times the job was tried to be processed. By default the job is not retried on error.

created_at (JSONDate)

dead_at (JSONDate)

when job has been considered as dead

error (String)

Deprecated

error_class (String)

class of an error which made the job fail

error_message (String)

error which made the job fail

failed_at (JSONDate)

when job failed

form_configuration_name (String)

Deprecated

form_name (String)

Deprecated

id (ID)

label (String)

Deprecated

liquid_body (JSONPayload)

locked_at (JSONDate)

Deprecated

queue (String)

which queue is used to process the job

resource_id (ID)

Deprecated

resource_type (String)

Deprecated

retry_at (JSONDate)

when job will retry to run

run_at (JSONDate)

when job is scheduled to run

source_name (String)

source_type (String)

Deprecated

started_at (JSONDate)

when job started to be processed

updated_at (JSONDate)

Deprecated

Contribute to this page

Github Icon

Questions?

We are always happy to help with any questions you may have.

contact us