Skip to content
Kindgi

List webhook endpoints

GET
/v1/webhook-endpoints
curl --request GET \
  --url 'https://example.com/v1/webhook-endpoints?limit=25' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
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 endpoints.

Media typeapplication/json
object
data
required
Array<object>
object
endpointId
required
string
url
required
string format: uri
events
required
Array<string>
Allowed values: run.finished
filter
required

Which events reach the endpoint. Every field narrows; absent fields do not. run.finished is sent for top-level runs only.

object
projectId

Only runs in this project.

string
>= 1 characters
flowIds

Only runs of these flows (any version).

Array<string>
>= 1 items <= 100 items
includeDryRuns

Dry runs are left out unless this is true.

boolean
description
required
string | null
secretRef
required

A secret by name in the deployment’s secrets store, resolved at tenant scope (the same shape as a provider’s secret_ref). The value is whsec_ + base64 of at least 24 random bytes (or that base64 alone); the store keeps it, the endpoint keeps only this reference.

object
envName
required
string
/^[a-z][a-z0-9-]{0,62}$/
name
required
string
>= 1 characters <= 256 characters
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
nextCursor
string
hasMore
required
boolean
Example
{
  "data": [
    {
      "events": [
        "run.finished"
      ]
    }
  ]
}

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"
  }
}