Skip to main content
POST
Rotate signing secret

Authorizations

x-api-key
string
header
required

API key (sk-proj-…) from Settings → API Keys. Required for sold API calls outside the Mermail console.

Path Parameters

workspaceId
string
required
webhookId
string
required

Response

Result including signingSecret once. Save it securely; list/get never return it.

id
string
required
urlHost
string
required
eventTypes
enum<string>[]
required
Required array length: 1 - 5 elements
Available options:
message.received,
message.sent,
message.delivered,
message.bounced,
message.complained
allInboxes
boolean
required

Includes future inboxes. When false select mailboxIds explicitly.

mailboxIds
string[]
required
Maximum array length: 500
status
enum<string>
required
Available options:
active,
paused,
disabled,
deleted
hasAuthorization
boolean
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
signingSecret
string

Returned once on initial creation or rotation. Omitted on idempotent creation replay. Save securely.

Pattern: ^whsec_