RunNotification

The payload of a Run’s completion webhook

This document describes the payload of a Run’s completion webhook.

Properties

id

string

required

The Run’s ID

ok

boolean

required

Whether the Run completed successfully or failed.

status

JobRunStatus

required

The Run’s status. Will always be "SUCCESS" if ok is true. If ok is false, will be one of "FAILURE" | "TIMED_OUT" | "ABORTED" | "CANCELED" | "UNRESOLVED_AUTH" | "INVALID_PAYLOAD"

statuses

JobRunStatusRecord[]

required

An array of the explicit run statuses that were created during the Run. See Explicit Status Hooks for more.

output

any

If the Run completed successfully, this will be the output of the Job.

error

any

If the Run failed, this will be the error that caused the failure.

startedAt

Date

required

When the Run started

completedAt

Date

required

When the Run started

isTest

boolean

required

Whether the Run was a test Run

executionDurationInMs

number

required

The duration of the Run in milliseconds

executionCount

number

required

The number of individual function executions performed to complete the Run

invocation

object

required

Metadata about the Invocation / Run

Show properties

id

string

required

The Run ID

payload

any

required

The payload that was passed to the Run

timestamp

Date

required

The timestamp of the event/Run

context

any

The context that was passed to the Run

job

object

required

Metadata about the Job

Show properties

id

string

required

The Job’s ID

version

string

required

The Job’s version

task

object

Metadata about the Task that failed, only exists if the Run failed

Show properties

id

string

required

The Task ID

cacheKey

string

The Task’s cache key

error

Error

required

And Error-like object that caused the Task to fail

status

string

required

The Task’s status

name

string

The Task’s name

startedAt

Date

When the Task started

params

any

The Task’s params

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

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

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