How To Configure Connections?

What is an Integration?

Integrations in Composio are configuration objects that define how your application connects to external services (like GitHub, Slack, or HubSpot). Each integration encapsulates authentication credentials (OAuth Client ID/Secret), permission scopes, and API specifications that determine how your users can interact with the external service. These configuration objects are used to configure and manage connections with external services.

For example:

• When you create a GitHub integration, you specify OAuth authentication parameters and permission scopes like repo:read
• This integration then serves as a reusable template - any user connecting their GitHub account through this integration will have the same standardized access level and authentication flow
• This ensures consistent and secure access patterns across your entire user base

Creating a New Integration

How to Fetch Integrations

1
from composio import ComposioToolSet, App
2
toolset = ComposioToolSet()
3
4
# get all integrations
5
print(toolset.get_integrations()) 
6
7
#filter based on app 
8
print(toolset.get_integrations(app=App.GMAIL)) 
9
10
#filter based on integration id
11
print(toolset.get_integration(id="<integration_id>")) 
12
13
# By auth scheme
14
print(toolset.get_integrations(auth_scheme="BEARER_TOKEN"))

Creating a new connection using an Integration

You can follow the same steps as mentioned in Creating a new connection and use integration object (Python) or integrationId (JavaScript).

1
from composio import ComposioToolSet
2
3
toolset = ComposioToolSet(entity_id="Jessica")
4
5
entity = toolset.get_entity()
6
7
integration = entity.client.integrations.get_by_id("integration_id...")
8
connection_request = entity.initiate_connection(
9
    app_name="TWITTER",
10
    redirect_url="https://yourwebsite.com/connection/success",
11
    integration=integration,
12
)
13
14
# If the connection method is OAuth, redirect the user to the URL below
15
print(connection_request.redirectUrl)

Using Your Own OAuth Developer App

When creating an integration, you can use your own OAuth Developer App instead of Composio’s default one, you can follow the same steps as mentioned in Creating a New Integration and:

1. Enable the toggle “Use your own Developer App”
2. Enter your OAuth credentials:
   • Client ID
   • Client Secret