Skip to content
Kindgi

List a webhook endpoint's deliveries

GET
/v1/webhook-endpoints/{endpointId}/deliveries
curl --request GET \
  --url 'https://example.com/v1/webhook-endpoints/example/deliveries?status=pending&limit=25' \
  --header 'Authorization: Bearer <token>'

Newest first. Each delivery carries the event it delivers.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
endpointId
required
string

The webhook endpoint id.

Query Parameters

Section titled “Query Parameters”
status

pending: waiting for its next attempt. delivered: the endpoint answered 2xx. failed: every attempt failed, or the endpoint was unregistered first; redeliver queues it again.

string
Allowed values: pending delivered failed

Only deliveries with this status.

limit
integer
default: 25 >= 1 <= 100

1..100. Default 25.

cursor
string

Opaque cursor from a prior response. Absent → first page.

Responses

Section titled “Responses”

200

Section titled “200”

Page of deliveries.

Media typeapplication/json
object
data
required
Array<object>
object
deliveryId
required
string
endpointId
required
string
event
required
One of: discriminator: type
object
id
required

Event id, also sent as the webhook-id header; the same on every retry.

string
type
required
string
Allowed value: run.finished
createdAt
required
string format: date-time
data
required
object
run
required

A finished top-level run: its identity and outcome, never its input or output. Field names match GET /v1/runs/{runId}.

object
id
required

RunId.

string format: uuid
projectId
required
string format: uuid
flowId
required
string
flowVersion
required
string
status
required
string
Allowed values: completed failed cancelled
dryRun
required
boolean
failureMessage
required

Why the run failed or was cancelled; null when it completed.

string | null
createdAt
required
string format: date-time
completedAt
required
string format: date-time
status
required

pending: waiting for its next attempt. delivered: the endpoint answered 2xx. failed: every attempt failed, or the endpoint was unregistered first; redeliver queues it again.

string
Allowed values: pending delivered failed
attempts
required
integer
nextAttemptAt
required
string | null format: date-time
lastAttemptAt
required
string | null format: date-time
lastResponseStatus
required

HTTP status of the last attempt; null when it got no response.

integer | null
lastError
required

Why the last attempt failed (timeout, connection-refused, url-refused, …).

string | null
createdAt
required
string format: date-time
deliveredAt
required
string | null format: date-time
nextCursor
string
hasMore
required
boolean
Example
{
  "data": [
    {
      "event": {
        "type": "run.finished",
        "data": {
          "run": {
            "status": "completed"
          }
        }
      },
      "status": "pending"
    }
  ]
}

400

Section titled “400”

Unknown status.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

Section titled “404”

No endpoint with that id.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}