v1

latestOpenAPI 3.1.02026-07-241695611.0 MB

Webhook Events

APIKey.created

Emitted when a new API Key is created.

postWebhookAPIKey.created

Payload

idstring uuid required

The ID of the API Key.

namestring required

The name of the API Key.

keystring required

The API Key.

default_request_mode'sync' | 'async' required

Controls whether API key-authenticated requests default to synchronous or asynchronous execution.

Existing API keys default to Async for backward compatibility. New organizations and federations are provisioned with Sync so new customers get immediate results. The Prefer header (RFC 7240) always takes precedence over this default.

federation_grantsFederationGrant[] nullable

Federation grants scoping this key. Populated only on federation API keys; null for organization and operator keys.

Example payload

{
  "name": "Default API Key",
  "key": "f9e67690304c23f133f7d965f130139d36f985b1ce8169a7d8ed99dbd5edc3b9"
}

Response

Successful Response

{"stackTrail":"webhooks:APIKey.created:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}