Skip to main content

Introduction

When a sink is configured, Run results are delivered to the sink destination. The payload is a JSON object containing the API Run result along with additional metadata. The structure is mostly similar between Jobs and Runs with some minor differences.

Format

apiInfo
object
required
Info about the API that was run. Includes the API name and result of run.
workspaceId
string
required
The workspace ID of the project that the run belongs to.
project
object
required
Details of the project that the run belongs to.
authSession
object
Details of the auth used in this run.
projectJob
object
Present when this Run is part of a Job. Contains information about the Job that triggered it.
projectJobRun
object
Present when this Run is part of a Job. Contains information about the JobRun that triggered it.