Rotate a webhook signing secret

Rotate a signing secret for a specific webhook.

For more information, see the guides: About webhooks and Manage webhooks.

Request​

Webhook signing secret rotation request

Path Parameters

Path Parameters

The ID of the webhook for which to rotate the secret.

Request body

Body object

Possible values: <= P7D
Example: "PT5H30M"

Default value: P0D

The expiration period for the signing secret in ISO 8601 format. If set, when you rotate the secret, it continues to be valid until the expiration period has passed. Otherwise, on rotation, the secret is invalidated immediately. The maximum value is 7 days.

Response​

The details of the webhook for which you rotated the signing secret

Response body

Body object

The ID of the webhook.

The valid webhook URL that event notifications are sent to. The supported protocol is https.

Possible values: [TransactionCreated, TransactionStateChanged, PayoutLinkCreated, PayoutLinkStateChanged]

The list of event types that you are subscribed to.

The signing secret for the webhook.