Webhook Configurations

Rotate the signing secret

Generate a new signing secret for an active webhook configuration. Both the old and the new secret are accepted for 24 hours, and the new one is returned only in this response. A disabled or circuit-broken configuration is rejected with InvalidWebhookConfigurationStateError: enable it first.

post/v0/webhook-configurations/{webhookConfigurationId}/rotate-secret

Request

Path parameters

webhookConfigurationIdstring uuid required

a Universally Unique Identifier

Response

Success

idstring uuid required

a Universally Unique Identifier

distributorIdstring uuid required

a Universally Unique Identifier

urlstring required
topicsstring[] required
signingSecretstring required
previousSigningSecretstring nullable required
secretRotatedAtstring nullable required

A valid date within the range 2020-2100

status'active' | 'disabled' | 'circuit-broken' required
consecutiveFailuresinteger required
createdAtstring required

A valid date within the range 2020-2100

updatedAtstring required

A valid date within the range 2020-2100

Changes

No recorded changes to this operation across all 1 revision of this API.