List an endpoint's recent deliveries

GET

/v1/webhooks/{id}/deliveries

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

Operation ID: webhookEndpoints.deliveries.list

Authorizations

• secretKey
• integrationKey

Parameters

Path Parameters

id

required

string

Responses

200

The endpoint’s last deliveries, newest first

Media typeapplication/json

Array<object>

object

attempts

required

How many times the delivery was tried, the try under way included. Null once the record of its tries is cleared: 7 days after it was delivered, 90 after it failed.

number | null

createdAt

required

number

eventId

required

string

eventType

required

string

id

required

string

lastError

required

string | null

nextAttemptAt

required

number | null

status

required

string

Examples

Exampleexample

Example

[
  {
    "attempts": 2,
    "createdAt": 1760000300000,
    "eventId": "1760000300000-0192f5a4-7c1e-4d3a-9b6e-2f4c8a1d5e70",
    "eventType": "order.status_changed",
    "id": "whd_8b1c3d5e7f9a0b2c4d6e8f0a",
    "lastError": "status 503",
    "nextAttemptAt": 1760000450000,
    "status": "pending"
  },
  {
    "attempts": 0,
    "createdAt": 1760000000000,
    "eventId": "1760000000000-6f1c8a2b-3d4e-4f5a-8b6c-7d8e9f0a1b2c",
    "eventType": "design.committed",
    "id": "whd_2a4c6e8f0b1d3f5a7c9e1b3d",
    "lastError": null,
    "nextAttemptAt": null,
    "status": "delivered"
  }
]

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

401

Refused: unauthorized

Media typeapplication/json

object

error

required

string

Examples

Exampleunauthorized

unauthorized

{
  "error": "unauthorized"
}

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

403

Refused: origin_forbidden, forbidden, feature_disabled

Media typeapplication/json

object

error

required

string

feature

The feature the tenant does not have. Always sent with feature_disabled.

string

Examples

feature_disabled

{
  "error": "feature_disabled",
  "feature": "api"
}

forbidden

{
  "error": "forbidden"
}

origin_forbidden

{
  "error": "origin_forbidden"
}

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

404

Refused: not_found

Media typeapplication/json

object

error

required

string

Examples

Examplenot_found

not_found

{
  "error": "not_found"
}

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

500

Refused: db_error. A request that failed unexpectedly answers as text instead.

object

error

required

string

Examples

Exampledb_error

db_error

{
  "error": "db_error"
}

string

Allowed value: Internal Server Error

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.