API Reference
API Reference

APIKey.created

webhook
APIKey.created

Emitted when a new API Key is created.

Payload
__event__
object
Defaults to [object Object]
uuid
required

The ID of the API Key.

string
required

The name of the API Key.

string
required

The API Key.

string
enum
required

The default execution mode for requests authenticated with this API key. 'sync' means requests block until completion; 'async' means requests return immediately with a 202 status. The Prefer header overrides this default.

Allowed:
array | null

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

array | null

Surfaces this organization key may reach ('api' for the customer HTTP API, 'exports' for the SFTP bulk data feed). Null means unscoped: full API access and no SFTP. Always null on federation and operator keys.

Responses

Updated 5 months ago

Did this page help you?
LoadingLoading…

Updated 5 months ago

Did this page help you?