@devries-cameron20 / composio Mirror · read-only
Fork 0

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

next
md 4.5 KB

How do I set up custom OAuth credentials for Zoho Invoice?

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 Invoice organization.

Create the Zoho OAuth client

  1. Sign in to the Zoho API Console with the account you use for Zoho Invoice. Use the console for your account's data center, for example https://api-console.zoho.in/ for India.
  2. 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.

Zoho API Console client type picker with Server-based Applications

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

Zoho API Console Create New Client form with the Composio redirect URI

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

Zoho API Console Client Secret tab with the Client ID and Client Secret (redacted)

Create the auth config in Composio

  1. In the Composio dashboard, go to Auth Configs → Create and select Zoho Invoice.

  2. 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.

  3. 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.

  4. Click Connect Account and enter your data center code in Domain Extension (see below).

Composio Connect Account form with a data center code in Domain Extension

  1. 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.

Zoho consent screen for Zoho Invoice with the consent checkbox and Accept button

Zoho Invoice auth config Accounts tab with the connected account Active

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 the .ALL scopes for contacts, settings, estimates, invoices, customer payments, credit notes, projects, and expenses (for example ZohoInvoice.invoices.ALL). For a read-only check of organization and user details, ZohoInvoice.settings.READ is enough. Check each tool against the Zoho Invoice API reference.

If you add scopes later, reconnect the account. An existing connection doesn't pick up new permissions.

Data center

Domain Extension is the ending of your Zoho Invoice web address: com for invoice.zoho.com, eu for invoice.zoho.eu, in for invoice.zoho.in, au for invoice.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 Domain Extension.
  • Permission or organization error: check that the user can access the Zoho Invoice organization and that the auth config requests the scope the tool needs.