API Client Bearer Token webhook

The API Client Bearer Token webhook is described below. Note that webhooks deliver only the event notification. The actual data must be read using the provided event details.

Webhook Subject: API_CLIENT_BEARER_TOKEN

Supported events:

  • CREATE
  • UPDATE
  • DELETE

Summary

Webhook for API client bearer token events to monitor API token state.

Description

API clients typically use bearer tokens for access, whether for server side 'secure' tokens or client side 'insecure' tokens which are typically more restricted in their permissions. The Bearer Token webhook allows integrations to monitor the issuance of bearer tokens to effectively manage the bearer token lifecycle and distribution. Rotating tokens regularly helps improve security so it is recommended to periodically create new tokens. Using the Bearer Token webhook your integration can always stay up to date with new token issuance and revocations.

Example

Below is an example webhook payload (pretty printed):

{
  "trigger" : {
    "urn" : "6099cb4a-00a5-4e08-8a8d-c570254b5757",
    "owner" : {
      "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
      "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
    },
    "timestamp" : "2026-05-29T13:45:32",
    "subject" : "API_CLIENT_BEARER_TOKEN",
    "event" : "CREATE",
    "targetUrn" : "fdcb0191-8408-4132-abf7-57adeafe59e2"
  },
  "subscription" : {
    "urn" : "691be1de-09df-411d-ad4a-3cc7ec771cd4",
    "subject" : "API_CLIENT_BEARER_TOKEN",
    "event" : "ALL",
    "destinationUrl" : "https://example.com/webhooks/apiclientbearertoken",
    "auth" : "BEARER",
    "expirationTimestamp" : "2026-06-28T13:45:32",
    "eventsPerMinute" : 500
  },
  "v1" : {
    "urn" : "fdcb0191-8408-4132-abf7-57adeafe59e2",
    "url" : "/n/v1/apiclientbearertoken/fdcb0191-8408-4132-abf7-57adeafe59e2"
  }
}