Read one delivery

GET

/v1/deliveries/{id}

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

• Production

Requires the deliveries:read scope.

Authorizations

• apiKey
• sessionCookie

Parameters

Path Parameters

id

required

string

Responses

200

Success

Media typeapplication/json

object

data

required

object

id

required

Resource id

string

projectId

required

string

eventId

required

string

destinationId

required

string

via

required

string

Allowed values: server cli

status

required

string

Allowed values: pending queued delivering retry_wait succeeded failed dead cancelled

attemptCount

required

integer

>= -9007199254740991 <= 9007199254740991

maxAttempts

required

integer

>= -9007199254740991 <= 9007199254740991

nextAttemptAt

required

Any of:

string

ISO-8601 timestamp

string

null

null

lastStatusCode

required

Any of:

integer

integer

>= -9007199254740991 <= 9007199254740991

null

null

lastErrorCode

required

string | null

lastErrorMessage

required

string | null

replayId

required

string | null

targetRunId

required

string | null

targetRunUrl

required

string | null

createdAt

required

ISO-8601 timestamp

string

updatedAt

required

ISO-8601 timestamp

string

key

additional properties

key

additional properties

Example

{
  "data": {
    "via": "server",
    "status": "pending"
  }
}

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