API Client webhook

The API Client 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

Supported events:

• CREATE
• UPDATE
• DELETE

Summary

API client webhook allows your integration to monitor when clients are created or updated

Description

Webhook events for API client creation are critical for implementing automations around scenarios like auditing API client usage. Using the API client creation event your integration can also automate tasks like assigning API client permission roles or scheduling key rotation tasks.

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",
    "event" : "CREATE",
    "targetUrn" : "fdcb0191-8408-4132-abf7-57adeafe59e2"
  },
  "subscription" : {
    "urn" : "691be1de-09df-411d-ad4a-3cc7ec771cd4",
    "subject" : "API_CLIENT",
    "event" : "ALL",
    "destinationUrl" : "https://example.com/webhooks/apiclient",
    "auth" : "BEARER",
    "expirationTimestamp" : "2026-06-28T13:45:32",
    "eventsPerMinute" : 500
  },
  "v1" : {
    "urn" : "fdcb0191-8408-4132-abf7-57adeafe59e2",
    "url" : "/n/v1/apiclient/fdcb0191-8408-4132-abf7-57adeafe59e2"
  }
}