Skip to main content
GET
/
v1
/
webhooks
/
endpoints
/
{endpoint_id}
/
keys
List webhook encryption keys
curl --request GET \
  --url http://127.0.0.1:8787/v1/webhooks/endpoints/{endpoint_id}/keys \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "webhook_endpoint_id": "<string>",
      "key_id": "<string>",
      "algorithm": "<string>",
      "key_type": "<string>",
      "jwk": {},
      "is_active": true,
      "created_at": "<string>",
      "updated_at": "<string>",
      "disabled_at": "<string>"
    }
  ],
  "error": null,
  "pagination": {
    "limit": 10,
    "has_more": false,
    "next_cursor": null
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
endpoint_id
string
required

The ID of the webhook endpoint whose keys should be listed (e.g. whe_...).

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$

Query Parameters

​
is_active
boolean

Filter keys by active state. If omitted, both active and inactive keys are returned.

​
limit
integer

Maximum number of keys to return. Defaults to 10 if not specified.

Required range: 1 <= x <= 100
​
starting_after
string

Cursor of the last item from the previous page. When provided, the next page of results will be returned.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$

Response

Successful operation.

​
data
object[]
required
​
error
null
required
​
pagination
object
required