Skip to content

Get a webhook (secret redacted)

projectId
required
string

Tenant project id (row-level isolation on every query).

id
required
string

Resource id.

Webhook.

Media typeapplication/json
object
webhook

Project outbound webhook (secret redacted as ‘***’).

object
id
string
projectId
string
name
string
url
string
secret

Always ‘***’ on read endpoints.

string
eventTypes
Array<string>
active
boolean
createdAt
string format: date-time
updatedAt
string format: date-time

Not authenticated (no valid session/principal).

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}

Authenticated but lacks the required project role.

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}

Resource not found (or belongs to another project — indistinguishable).

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}