Skip to content

Set/rotate a channel's ESP webhook signing secret

Requires EDITOR. Only valid for resend/aliyun channels (others 400). Stores the secret (encrypted at rest) without requiring the send credentials.

projectId
required
string

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

id
required
string

Resource id.

Media typeapplication/json
object
webhookSecret
required
string
>= 1 characters <= 500 characters
Examplegenerated
json
{
"webhookSecret": "example"
}

Acknowledged.

Media typeapplication/json
object
ok
boolean

Validation error, or channel kind does not receive ESP webhooks.

Media typeapplication/json
object
error
required

Human-readable error message.

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

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"
}