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

job
object
required

Metadata about the Job

task
object

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

environment
object
required

Metadata about the Environment

organization
object
required

Metadata about the Organization

project
object
required

Metadata about the Project

account
object

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

Was this page helpful?