​
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

A single integration can be used by multiple users to connect their accounts. Ideally, create one integration per app unless you need different configurations for specific use cases.

  1. Login at Composio’s Website
  2. Go to the Tools section
  3. Click on any app you want to integrate
  4. Click on Setup on [App Name] Integration
  5. Choose your integration name and click Save

​
How to Fetch Integrations

​
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).

​
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

When users connect using this integration, they’ll see your app’s name and logo in the OAuth consent screen instead of Composio’s. Checkout the live demo here

​
Adding custom redirect URL

To use your own domain for OAuth callbacks, set up a 301 redirect from your domain to Composio’s default . It would look something like this:
yourdomain.com/redirect → https://backend.composio.dev/api/v1/auth-apps/add

1

Copy the redirect URL

Redirect URL
https://backend.composio.dev/api/v1/auth-apps/add
2

Go to your DNS provider and set up a 301 redirect

Head over to your DNS provider and set up a 301 redirect from your domain to Composio’s default redirect URL, here are doc references for some of the popular DNS providers: Cloudflare, GoDaddy, NameCheap

Please make sure that you enable the Preserve query string option when setting up the redirect. If you’re using your own custom application code for redirect, please remember to pass the exact query parameters and headers

3

Creating an integration

Head over to dashboard, select the app you want to integrate and enable Use your own Developer App toggle, enter your OAuth credentials and click on the edit button and add your own redirect URL (yourdomain.com/redirect). Click on Create Integration and you’re done.

Was this page helpful?

Suggest editsRaise issue
Using ConnectionsExample Flow - Gmail