BRbrex-com
Webhook Subscriptions

List Webhook Secrets

This endpoint returns a set of webhook signing secrets used to validate the webhook. Usually only one key will be returned in the response. After key rotation, this endpoint will return two keys: the new key, and the key that will be revoked soon. There will also be two signatures in the 'Webhook-Signature' request header. Your application should use all keys available to validate the webhook request. If validation passes for any of the keys returned, the webhook payload is valid.

get/v1/webhooks/secrets

Request

Response

Success

secretstring required

The payload of the secret to be used for webhook validation.

status'ACTIVE' | 'PENDING_REVOKE' | 'REVOKED' required

The status of this webhook secret.

Example response

[
  {
    "secret": "whsec_123"
  }
]

Changes

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