Skip to main content
This guide adds an integration in the dashboard: a stored credential, such as a database connection string or a bot token, that agents look up by id. Use it when an action, an entry, or a tool asks for an integration you do not have yet.

Before you begin

Add the integration

1

Open Integrations

In the sidebar under Configure, open Integrations. The page lists every integration by id and type, and each row has edit and delete controls.
The Integrations page listing integrations by id and type, with the New Integration button
2

Choose a type

Click New Integration and choose a type. Discord, GitHub App, and Notion are marked Guided setup and open a flow of their own. Every other type opens a form with one input per field.
The New Integration dialog listing every integration type
For a guided setup, see Connect an agent to Discord.
3

Enter an id and the fields

Enter an Id, for example orders-db. Agents reference the integration by this id, and it cannot be changed later, so choose a name that says what it connects to.Fill in the fields. A required field is marked with an asterisk. A select field, such as SQL Database’s Database Type, lists its allowed values.
The New Integration form for SQL Database with the Id, Connection String, and Database Type fields
4

Keep the credential in Secrets

A password field, such as Connection String or Bot Token, opens a secret picker. Choose a stored secret, or choose + New secret… to store the value now. The form then keeps a reference, and the value stays in Secrets.To paste the value into the integration instead, choose Enter a value directly…. The form warns that the value is stored in the integration’s config as typed. Any other field can hold a reference too: click Use a stored secret instead under it. See Secrets.
5

Add it

Click Add Integration. The dialog closes, and the integration appears in the list with its type. The server reloads its configs, so the integration is usable at once.

Use the integration from an agent

Any field that takes an integration lists the stored ones by id, filtered to the types that field accepts. In an action step, this is the step’s integration field. In an entry, it is a field such as the Discord entry’s Bot. Choose the integration, or choose + New integration… to add one without leaving the editor.
An agent's entry panel with a stored integration chosen under Bot

Edit or delete an integration

On the Integrations page, the pencil on a row opens the same form with the Id locked, because configs reference it. Change the fields and click Save Changes. A password field that holds a literal value opens blank. Leave it blank to keep the stored value, or enter a replacement.
The edit dialog for an existing integration with the Id field locked
The trash icon deletes the integration. A step or entry that references the deleted id fails until it is pointed at another integration.

Verify

The integration appears in the list on the Integrations page. From the terminal, it also appears in:
The list shows ids and types only. Config is never printed.

Integrations reference

Every type, its fields, and what uses it.

Secrets

Store a credential once and reference it from an integration.

Connect an agent to Discord

A guided setup, end to end.

Creating your first agent

Build the agent that uses the integration.