webhooks

Rotate webhook signing secret

Generates a new signing secret for the specified webhook. The old secret is immediately invalidated. Make sure to update your verification logic with the new secret.

post/webhooks/{webhookId}/rotate-secret

Request

  • Base URL: https://docs-api.formify.eu/v1
  • URL: https://docs-api.formify.eu/v1/webhooks/{webhookId}/rotate-secret
  • Auth: OAuth 2 (authorization code, authorization URL https://docs-api.formify.eu/v1/oauth/authorize, token URL https://docs-api.formify.eu/v1/oauth/token)

Path parameters

webhookIdstring uuid required

The unique identifier of the webhook.

Query parameters

errorLanguage'en' | 'sv' | 'es'

Language for the error message

Response

Secret rotated successfully.

webhookIdstring uuid

The unique identifier of the webhook.

signingSecretstring

The new signing secret.

Example response

{
  "signingSecret": "whsec_bmV3IHNlY3JldCBnZW5lcmF0ZWQ="
}

Changes

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