Skip to main content
POST
Rotate the customer webhook signing secret

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128
Idempotency-Key
string
required

Identifies one mutation and its canonical request payload.

Required string length: 1 - 128

Path Parameters

project_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
environment_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

Authorized mail result with the new signing secret.

url
string<uri>
required
signing_secret
string
required

Server-only signing secret. Never log or send it to the browser.

status
string
required
Allowed value: "verification_required"