Skip to content

List the agent's webhooks (secrets redacted)

GET
/v1/webhooks

Ok

object
items
Array<object>

A webhook registration. secret is present only on the create response (shown once); list/get redact it. inbox is null when the webhook covers every inbox.

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

Agent that owns the webhook.

string
secret

HMAC signing secret. Create response only.

string
secret_prefix
string
active
boolean
created_at
string format: date-time
total
integer

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