Read an agent run linked to a delivery

GET

/v1/runs/{runId}

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

• Production

Requires the deliveries:read scope.

Authorizations

• apiKey
• sessionCookie

Parameters

Path Parameters

runId

required

string

Responses

200

Success

Media typeapplication/json

Automation task run

object

key

additional properties

Example ^generated

{
  "additionalProperty": "example"
}

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

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

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

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

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

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

404

Resource not found

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

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

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

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

Headers

X-RateLimit-Limit

integer

Requests allowed per window

X-RateLimit-Remaining

integer

X-RateLimit-Reset

integer

Seconds until the window resets