Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 21, 04:45 UTC
How do I set up custom OAuth credentials for Zoho Bigin?
Use your own Zoho OAuth client when you want the consent screen to show your app name and to manage the client credentials yourself. You need access to an existing Zoho Bigin organization.
Create the Zoho OAuth client
- Sign in to the Zoho API Console with the account you use for Zoho Bigin. Use the console for your account's data center, for example
https://api-console.zoho.in/for India. - Click Add Client (or Get Started for your first client) and choose Server-based Applications → Create Now. You can reuse an existing server-based client if it has the right redirect URI.

- Enter a Client Name and a Homepage URL. Use your own product name: Zoho rejects client names that contain
ZOHO. - In Authorized Redirect URIs, enter
https://backend.composio.dev/api/v1/auth-apps/add. It must exactly match the auth config'soauth_redirect_urifield.

- Click Create, then open the Client Secret tab and copy the Client ID and Client Secret.

Create the auth config in Composio
In the Composio dashboard, go to Auth Configs → Create and select Zoho Bigin.
Choose OAuth 2.0 and Your Own Credentials, then paste the Client ID and Client Secret. Leave Redirect URI as the value you registered in Zoho.
In Scopes, keep only what your workflow needs. To add a scope that isn't listed, type its exact name and click Add scope. Click Create Auth Config.
Click Connect Account and enter your data center code in Region (see below).

- Sign in to Zoho, review the app name, organization, and permissions, tick the consent checkbox if shown, and click Accept. Then open the auth config's Accounts tab and check that the account shows Active. The config showing Enabled doesn't mean an account is connected.


See custom auth configs for the general flow.
Scopes
Zoho takes scopes from the authorization request, so you set them in the auth config, not in the API Console. The default auth config requests ZohoBigin.modules.ALL, ZohoBigin.users.ALL, ZohoBigin.org.ALL, ZohoBigin.settings.ALL, ZohoBigin.bulk.ALL, and ZohoBigin.notifications.ALL. For a read-only check of organization details, ZohoBigin.org.READ is enough. Check each tool against the Bigin API reference.
If you add scopes later, reconnect the account. An existing connection doesn't pick up new permissions.
Data center
Region is the ending of your Zoho Bigin web address: com for bigin.zoho.com, eu for bigin.zoho.eu, in for bigin.zoho.in, au for bigin.zoho.com.au. Other options are jp, ca, cn, and sa. Enter the code only, not a full URL. The client's data center and the account's data center must be compatible. If your app connects accounts in more than one data center, enable multi-DC support for those regions on the client in the API Console.
Troubleshooting
- Redirect mismatch: compare the full callback URL in Zoho and in Composio, including the path.
- Invalid client or data center error: check the API Console's data center, the account's data center, and Region.
- Permission or organization error: check that the user can access the Zoho Bigin organization and that the auth config requests the scope the tool needs.
- "Cannot grant these permissions as you don't have access to Bigin": ask your Zoho One administrator to assign Bigin to your user, then retry. Registering an OAuth client doesn't give an account access to Bigin.