Context

The third parameter in a Job’s run() function. An object that contains information about the Organization, Job, Run and more.

context has useful information about the:

• Job
• Environment
• Organization
• Run
• event
• source
• account

Properties

job

object

required

Metadata about the Job

Show properties

id

string

required

The Job’s ID

version

string

required

The Job’s version

environment

object

required

Metadata about the Environment

Show properties

slug

string

required

The Environment’s slug

id

string

required

The Environment’s ID

type

string

required

The Environment’s type. One of: “PRODUCTION”, “STAGING”, “DEVELOPMENT”, “PREVIEW”.

organization

object

required

Metadata about the Organization

Show properties

slug

string

required

The Organization’s slug

id

string

required

The Organization’s ID

title

string

required

The Organization’s title

run

object

required

Metadata about the Run

Show properties

id

string

required

The Run’s ID

isTest

boolean

required

Whether the Run is a test run

startedAt

Date

required

When the Run started

project

object

required

Metadata about the Project

Show properties

slug

string

required

The Project’s slug

id

string

required

The Project’s ID

name

string

required

The Project’s title

event

object

required

Metadata about the Event that triggered the Run.

Show properties

id

string

required

The Event’s ID

name

string

required

The Event’s name

context

any

required

The Event’s context. This is additional data that been passed through

timestamp

Date

required

When the Event was triggered

source

object

Metadata about the Source that triggered the Run.

Show properties

id

string

required

The Source’s ID

metadata

any

The Source’s metadata. This is additional data that been passed through

account

object

Metadata about the Account that triggered the Run. See the BYO Auth docs for more information.

Show properties

id

string

required

The Account’s ID

metadata

any

The Account’s metadata. This is additional data that been passed through