Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

next
md 68 lines 5.99 KB
Rendered Raw
1 ## How do I set up custom Google OAuth credentials for Google Chat?
2
3 Composio doesn't provide a managed OAuth app for Google Chat, so you need your own Google OAuth app to connect it.
4
5 Connect with a Business or Enterprise Google Workspace account that has Google Chat access.
6
7 ### Create the Google OAuth app
8
9 1. In [Google Cloud Console](https://console.cloud.google.com/), select the project that will own the OAuth client, or create one.
10
11 ![Google Cloud console project picker](/images/toolkits/shared/9j8wjr2HocIhIsgedntpgb4m8Y.webp)
12
13 2. Open **APIs & Services** → **Library**, search for **Google Chat API** (`chat.googleapis.com`), and select **Enable**. If the page shows **Manage**, the API is already enabled. You don't need to request manual approval for this API.
14
15 ![API Library search results for Google Chat API](/images/toolkits/google_chat/search-chat-api.webp)
16
17 ![Google Chat API product page with the Enable button and the chat.googleapis.com service name](/images/toolkits/google_chat/enable-chat-api.webp)
18
19 3. If your workflow creates, updates, or deletes Chat resources, open **Google Chat API** → **Configuration** and enter an app name, avatar URL, and description. Leave interactive features off for an API-only app. You don't need a Cloud Run deployment. Read-only calls don't need this step. See Google's [Chat API setup](https://developers.google.com/workspace/chat/configure-chat-api).
20 4. Open **Google Auth Platform** → **Branding**. If Google shows **Get started**, enter the app name, user support email, and developer contact email, then save.
21
22 ![Google Auth Platform Branding page with app name and user support email](/images/toolkits/shared/Q8INvnJoiCMyajqrrAtq6ovCE5U.webp)
23
24 5. Open **Audience**. Choose **Internal** to limit the app to users in your Google Workspace organization, or **External** for consumer accounts and users outside it. While an external app's publishing status is **Testing**, only accounts listed under **Test users** can connect, so add every account you'll test with.
25
26 ![Google Auth Platform Audience page with Testing status, External user type, and Test users](/images/toolkits/shared/BetTxXqa2c1dgg4QeV4g9RV008.webp)
27
28 6. Open **Data Access** → **Add or remove scopes** and add the scopes listed under **Scopes** below. If a scope isn't in the list, paste its full URL under **Manually add scopes** and select **Add to table**. Select **Update**, then **Save**.
29
30 ![Data Access scope picker with the chat.spaces.readonly scope selected](/images/toolkits/google_chat/data-access-chat-scope.webp)
31
32 7. Open **Clients** → **Create client**, choose **Web application**, and give it a name.
33
34 ![Create OAuth client ID form with Web application selected](/images/toolkits/shared/S7mFFv6C5mCP4y0ScTzRzQd8Nc.webp)
35
36 8. Under **Authorized redirect URIs**, add `https://backend.composio.dev/api/v1/auth-apps/add`. It must exactly match the `oauth_redirect_uri` field on your Composio auth config.
37
38 ![OAuth client form with the Composio redirect URI under Authorized redirect URIs](/images/toolkits/shared/1qh7A0aEGRUU1K19aU37FrcxTY.webp)
39
40 9. Select **Create**. Copy the **Client ID** and **Client secret**. Google shows the full secret only once, so save it before you close the dialog.
41
42 ![Google OAuth web client details with Client ID and Client secret](/images/toolkits/shared/TmVTLOgVKQDqamjQVxKDBXJtPQ.webp)
43
44 ### Create the auth config in Composio
45
46 1. In the [Composio dashboard](https://dashboard.composio.dev/~/project/auth-configs?utm_source=docs&utm_medium=content&utm_campaign=toolkits-google_chat), open **Auth Configs** → **Create** and select **Google Chat**.
47 2. Choose **OAuth 2.0** and **Your Own Credentials**, then paste your **Client ID** and **Client secret**. Leave **Redirect URI** unchanged, keep the scopes in line with what you added in Google, and select **Create Auth Config**.
48 3. Open the auth config, select **Connect Account**, and sign in with the Google account you want to connect. Review the requested permissions before you continue.
49
50 ![Google consent screen asking to view chat and spaces in Google Chat](/images/toolkits/google_chat/google-consent-screen.webp)
51
52 4. Open **Accounts** on the auth config and confirm the connected account shows **Active**. The auth config's own **Enabled** label doesn't confirm a connection.
53
54 For the general flow, see [Custom auth configs](/docs/auth-configuration/custom-auth-configs).
55
56 ### Scopes
57
58 The default auth config requests `chat.spaces`, `chat.messages`, `chat.messages.create`, `chat.memberships`, and `chat.users`, plus read-only variants of spaces, messages, and memberships, all under `https://www.googleapis.com/auth/`. For read-only use, `https://www.googleapis.com/auth/chat.spaces.readonly` is enough to view the spaces the user belongs to. Remove scopes you don't need. See Google's [Chat scope reference](https://developers.google.com/workspace/chat/authenticate-authorize).
59
60 Short scope names on this page leave out the `https://www.googleapis.com/auth/` prefix. When you paste a scope under **Manually add scopes**, use the full URL, for example `https://www.googleapis.com/auth/userinfo.email`. Scopes already written as a full URL, such as `https://mail.google.com/`, go in as shown.
61
62 ### Publish and verify the app
63
64 While an external app is in **Testing**, Google shows an unverified-app notice and refresh tokens expire after seven days, so users have to reconnect. Before you invite production users, select **Publish app** on the **Audience** page. A public app that requests sensitive or restricted scopes also needs Google's OAuth verification, which you start from **Verification Center**. Publishing doesn't complete verification on its own. Internal apps and apps in Testing can be exempt. See Google's [verification requirements](https://developers.google.com/identity/protocols/oauth2/production-readiness/overview).
65
66 ![Google hasn't verified this app notice for an app in Testing](/images/toolkits/shared/Mavl5IyzWvxI5tP64ScXgpeyI94.webp)
67
68 If you change the requested scopes later, reconnect the account so the user grants the new access.