Skip to content

API Keys

API keys allow automated clients to call tenant APIs within the scopes you define. Keys are tied to the tenant and audited.

Prerequisites

Section titled “Prerequisites”
  • settings.api_keys.manage
  • module.settings

Create a key

Section titled “Create a key”

  1. Go to Settings and open the API keys section (tenant integrations UI).

  2. Create a key with a descriptive label and optional expiry.

  3. Copy the secret immediately — it cannot be retrieved later.

  4. Store in a secret manager; rotate on schedule or after personnel changes.

Webhooks

Section titled “Webhooks”

Security ingest webhooks use separate integration tokens — configure under Security → Integrations when module.security is enabled.

See also

Section titled “See also”