v1

latestOpenAPI 3.1.02026-07-141045121.7 KB
Subscriptions

Rotate the signing secret of a webhook subscription

🔑

Required OAuth scope: webhookSecrets:write.

Rotates the signing secret for the given webhook subscription. In addition to the new signature, the events will also be signed with the legacy secret for 24 hours.

post/api/v2/webhooks/subscriptions/{subscriptionId}/secrets/rotate

Path parameters

subscriptionIdstring ObjectId required
Example:507f1f77bcf86cd799439011

The unique ID of the webhook subscription.

Headers

360-api-version'v2.0' required

The version of the API.

Response

Returns the new signing secret of the webhook subscription.

secretstring required

The signing secret of the webhook subscription. You can use this secret to verify the authenticity of the received events.

Example response

{
  "secret": "password123"
}