Skip to content
Browse documentation

OpenAPI operations

List task runs

GET
/v1/tasks/runs
curl --request GET \
  --url https://api.hooks.events/v1/tasks/runs \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json

Task run list; not cursor-paginated

object
data
required
Array<object>

Task run summary

object
id
required

Resource id

string
kind
required
string
Allowed values: task delivery
engineId
required
string
taskName
required
string
environmentId
required
string | null
environmentName
required
string | null
status
required

Lifecycle status of a task run

string
Allowed values: queued starting running waiting cancelling done failed cancelled
error
required
string | null
currentStepIndex
required
integer
>= -9007199254740991 <= 9007199254740991
stepCount
required
integer
>= -9007199254740991 <= 9007199254740991
eventId
required
string | null
rerunOf
required
string | null
createdAt
required

ISO-8601 timestamp

string
updatedAt
required

ISO-8601 timestamp

string
durationMs
required
number
artifacts
required
object
prUrl
required

First GitHub pull-request link found in step outputs

string | null
machineId
required
string | null
externalRunId
string | null
externalRunUrl
string | null
key
additional properties
agentSession
required
Any of:
object
kind
required
string
Allowed values: slack linear
id
required
string
channelId
required
string | null
threadTs
required
string | null
sessionId
required
string | null
destinationId
required
string | null
tokenSecret
required

Project secret name, never the secret value

string
status
required
string
Allowed values: processing waiting_approval done stopped
steps
required
Array<object>
object
callId
required
string
title
required
string
status
required
string
Allowed values: running succeeded failed
detail
required
string | null
updatedAt
required

ISO-8601 timestamp

string
key
additional properties
approvals
required
Array<object>
object
callId
required
string
title
required
string
detail
required
string | null
requestedAt
required

ISO-8601 timestamp

string
decision
required
Any of:
string
Allowed values: approve deny
decidedBy
required
string | null
decidedAt
required
Any of:

ISO-8601 timestamp

string
messageTs
required
string | null
key
additional properties
decisions
required
Array<object>
object
seq
required
integer
>= -9007199254740991 <= 9007199254740991
callId
required
string
decision
required
string
Allowed values: approve deny
decidedBy
required
string
at
required

ISO-8601 timestamp

string
key
additional properties
followUps
required
Array<object>
object
seq
required
integer
>= -9007199254740991 <= 9007199254740991
text
required
string
userId
required
string | null
at
required

ISO-8601 timestamp

string
key
additional properties
stopRequested
required
boolean
streamedText
required
string
receivedEventIds
required
Array<string>
updatedAt
required

ISO-8601 timestamp

string
key
additional properties
key
additional properties
total
required

Total matching runs before the limit slice

integer
>= -9007199254740991 <= 9007199254740991
key
additional properties

Example 

{
  "data": [
    {
      "kind": "task",
      "status": "queued",
      "agentSession": {
        "kind": "slack",
        "status": "processing",
        "steps": [
          {
            "status": "running"
          }
        ],
        "approvals": [
          {
            "decision": "approve"
          }
        ],
        "decisions": [
          {
            "decision": "approve"
          }
        ]
      }
    }
  ]
}

400

Section titled “400”

Validation error

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required
string
requestId
required

Request id, also echoed in x-request-id

string
issues

Per-field validation details for VALIDATION_ERROR

Array<object>
object
path
required

Body or query field that failed validation

string
message
required
string
key
additional properties
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example",
    "issues": [
      {
        "path": "example",
        "message": "example"
      }
    ]
  }
}

401

Section titled “401”

Missing or invalid credentials

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required
string
requestId
required

Request id, also echoed in x-request-id

string
issues

Per-field validation details for VALIDATION_ERROR

Array<object>
object
path
required

Body or query field that failed validation

string
message
required
string
key
additional properties
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example",
    "issues": [
      {
        "path": "example",
        "message": "example"
      }
    ]
  }
}

403

Section titled “403”

The credential lacks the required scope, or the workspace is not writable

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required
string
requestId
required

Request id, also echoed in x-request-id

string
issues

Per-field validation details for VALIDATION_ERROR

Array<object>
object
path
required

Body or query field that failed validation

string
message
required
string
key
additional properties
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example",
    "issues": [
      {
        "path": "example",
        "message": "example"
      }
    ]
  }
}

429

Section titled “429”

Rate limited

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required
string
requestId
required

Request id, also echoed in x-request-id

string
issues

Per-field validation details for VALIDATION_ERROR

Array<object>
object
path
required

Body or query field that failed validation

string
message
required
string
key
additional properties
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example",
    "issues": [
      {
        "path": "example",
        "message": "example"
      }
    ]
  }
}

Headers

Section titled “Headers”
X-RateLimit-Limit
integer

Requests allowed per window

X-RateLimit-Remaining
integer
X-RateLimit-Reset
integer

Seconds until the window resets

Retry-After
integer

Seconds to wait before retrying. Absent when the rejection has no retry time (for example the Free lifetime quota).

X-Quota-Limit
integer

Request allowance for the workspace’s plan

X-Quota-Remaining
integer

Requests left in the allowance after this request