Webhooks

Configure webhook secret

This API configures the secret key for account-level webhook signature verification. Use this API to add a new secret or update an existing one. The secret is used to sign webhook payloads using HMAC SHA256, allowing you to verify that requests originate from Ocrolus.

🚧 We have a better version! This product is superseded by Org Level Webhooks, which we recommend for improved functionality and integration.

post/v1/account/settings/webhook/rotate-secret

Request

  • Base URL
    https://api.ocrolus.com
  • URL
    https://api.ocrolus.com/v1/account/settings/webhook/rotate-secret
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.ocrolus.com/oauth/token

Request body

secret_keystring required

The new webhook secret key. Must be between 16 and 128 characters long.

Example request

{
  "secret_key": "sample_secret_1230ab"
}

Response

Success

Changes

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