Skip to content

List webhooks within the caller's resource boundary (secrets redacted)

GET
/v1/webhooks
org_id
string

Select an organization within the connection grant.

project_id
string

Narrow to a project within the connection grant.

limit
integer
default: 50 >= 1 <= 100

Page size for the cursor-paginated agent surface (default 50; clamped to the 1-100 range).

cursor
string

Opaque pagination cursor echoed back from a prior next_cursor. Treat it as an opaque token; pass it back verbatim as ?cursor to fetch the next page.

Ok

object
object
required
string
Allowed values: list
data
required
Array<object>

A webhook registration. secret is present only on the create response (shown once); list/get redact it. The durable resource_scope defines the delivery boundary. inbox is an additional address filter; null removes that filter without widening selected stable inbox IDs. Registrations survive the creating connection’s expiry and must be deleted separately.

object
id
string
url
string
events
Array<string>
Allowed values: message.received
inbox
string
nullable
agent_id

Agent identity recorded at creation.

string
resource_scope

Agent-owned inboxes for legacy keys; stable selected inbox IDs, project, or organization for connections. Project and organization scopes include future inboxes.

string
Allowed values: agent inboxes project organization
inbox_ids

Stable inbox IDs for an inboxes-scoped registration.

Array<string>
<= 100 items
created_by_connection_id

Creating connection ID when applicable.

string
secret

HMAC signing secret. Create response only.

string
secret_prefix
string
active
boolean
created_at
string format: date-time
has_more
required
boolean
next_cursor
string
nullable

Missing or invalid credential.

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope
reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string
used

Consumed plus reserved units.

integer format: int64
delta

Requested additional units.

integer format: int64
limit
integer format: int64
remaining
integer format: int64
consumed
integer format: int64
reserved
integer format: int64
next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time
upgrade_required
boolean