Skip to main content
GET
List realm webhooks
Each webhook comes with every event it is subscribed to and whether that event is currently delivered (status). Filter by events (comma-separated) and page with limit + next. Only realm admins can call this.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

Query Parameters

events
string[]

Only the webhooks subscribed to at least one of these events, whatever the subscription's status. Each webhook still lists every event it is subscribed to.


Example (comma-separated list): ?events=PIX_IN,PIX_OUT

Maximum array length: 100
Required string length: 1 - 100
limit
integer

Page size, 1–100. Defaults to 15.

Required range: 1 <= x <= 100
next
string

Cursor returned as next by the previous page. Omit for the first page.

Response

Successful response

A page of webhooks.

items
object[]
required

Webhooks, newest first.

next
string | null
required

Cursor for the next page. null on the last page.

Example:

"NjcxMWI0YzBkOGUxYTMwMDEyYjdjOWYy"