Register a project webhook
POST /v1/admin/orgs/{org_id}/projects/{project_id}/webhooks
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Request Body required
Section titled “Request Body required ”object
AgentMail-compatible alias for events.
Scope to one mailbox; omit for all.
Legacy alias for inbox.
Optional idempotency key (alias for the Idempotency-Key header). A retry with the same key replays the original webhook registration.
Active agent that owns the webhook registration.
Responses
Section titled “ Responses ”Registered. secret is shown once.
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
Agent that owns the webhook.
HMAC signing secret. Create response only.
Invalid request.
The canonical error envelope. error is a stable machine code.
object
Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).
Example
forbiddenHuman-readable detail (never leaks internals).
Example
missing required scopeMissing or invalid credential.
The canonical error envelope. error is a stable machine code.
object
Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).
Example
forbiddenHuman-readable detail (never leaks internals).
Example
missing required scopeResource not found.
The canonical error envelope. error is a stable machine code.
object
Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).
Example
forbiddenHuman-readable detail (never leaks internals).
Example
missing required scope