For the complete documentation index, see llms.txt. This page is also available as Markdown.

System Integrations

Use System Integrations to create API-only identities for automation — CI/CD pipelines, scheduled jobs, and third-party services — that need standing API access without being tied to one employee's account.

Each System Integration is assigned one or more Roles at creation. Every API Key created under that integration inherits its integration's current Roles live, so updating an integration's Roles updates every key under it at once.

Managing System Integrations requires the Integration Admin role. This is a separate role from Admin — see Roles and Permissions.

Create an Integration

1

Open Integrations

From Administration, select Integrations.

2

Create an integration

Select Create Integration, enter a name, and select one or more Roles. Submit the form to create the integration.

System Integrations are always visible platform-wide (Global) — see Resource Visibility and Assignment. You can't scope an integration's visibility to a specific group or user in this release.

Manage an Integration's API Keys

Select Manage Keys on an integration to open its API Keys list, then Create API Key to add one. Each key shows a read-only summary confirming it inherits the integration's Roles, plus an expiration date of up to one year.

Replica shows the plaintext key once, immediately after creation. Copy it before closing the panel — you won't be able to view it again.

Select Revoke to permanently disable a key.

Enable and Disable an Integration

Disabling an integration blocks every API Key under it from authenticating, without deleting the integration or its keys. Re-enable it to restore access.

To change an integration's status, select Disable Integration or Enable Integration in its actions.

Last updated

Was this helpful?