Skip to main content
POST
Rotate Webhook HMAC Secret

Path Parameters

portfolio_id
string
required
subscription_id
string
required

Body

application/json

RotateWebhookHMACSecretRequest is the request message for rotating a webhook HMAC signing secret.

revoke_previous_immediately
boolean

revoke_previous_immediately invalidates the old secret immediately instead of keeping it valid for the server grace window. Use when the secret may be compromised.

Response

A successful response.

RotateWebhookHMACSecretResponse is the response message for rotating a webhook HMAC signing secret.

subscription
object

WebhookSubscription is the customer-facing representation of a webhook subscription. auth secrets (hmac_secret, oauth client_secret) are never included; hmac_secret is returned exactly once in CreateWebhookSubscriptionResponse.

hmac_secret
string

hmac_secret is the new plaintext HMAC signing secret. Returned exactly once; store it securely — it is never surfaced again.

previous_secret_expires_at
string<date-time>

previous_secret_expires_at is when the prior secret stops being accepted. Unset when revoke_previous_immediately was true.