Integrations Setup
Configure external apps to prepare them for user connections
An Integration is the developer-level configuration within Composio for a specific external app (like GitHub, Slack, Google Calendar). It acts as the blueprint defining how Composio should interact with that app, including its authentication method (OAuth, API Key, etc.) and API details.
- Integrations do not store individual user credentials.
- You typically create an Integration once per app, per environment (e.g., one for development, one for production).
- The main outcome is obtaining a unique
integration_id
, which you’ll use later to connect your users.
Creating an Integration
You can set up Integrations via the Composio Dashboard (recommended for visual configuration) or the CLI.
Dashboard (Recommended)
CLI
Code (Advanced)
The dashboard offers a guided process for all app types.
Configure Integration Settings (If Required)
The next steps depend on the app’s authentication method:
- For OAuth 2.0 Apps: You’ll need to decide whether to use Composio’s default OAuth app or your own developer credentials. For more details, see Handling OAuth Connections and White-labelling.
- For API Key/Token Apps: The keys are typically provided by the end-user later in the connection flow. See Handling API Key Connections for that process.
You might also configure default scopes or API base URLs here if applicable.
Using the Integration ID
The key outcome of this setup process is the integration_id
. This unique identifier represents the specific configuration you’ve created for an app within Composio.
You will use this integration_id
in the next step to initiate the authentication flow for your end-users.
➡️ Next: Connecting Users Overview