@devries-cameron20 / composio-1 / commits / 3b98fda53
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.

docs: show the Connect Link in Spanish or Simplified Chinese with a locale parameter (#4886)

Restores the Connect Link locale docs reverted in #4885 now that ComposioHQ/dashboard#1802 is live, and dates the changelog 2026-10-15.

Brendan O'Leary committed Oct 15, 2026 at 16:15 UTC 3b98fda534df0f828a794f8f203cdd495138f941
3 files changed +103
docs/content/changelog/10-15-26-connect-link-languages.mdx new
+15
@@ -0,0 +1,15 @@
1 +---
2 +title: "Show the Connect Link in Spanish or Simplified Chinese"
3 +description: "Add a locale parameter to the Connect Link URL to show the hosted connection page in your user's language."
4 +date: "2026-10-23"
5 +---
6 +
7 +The Connect Link can now show its text in Spanish or Simplified Chinese. Add a `locale` parameter to the Connect Link URL, such as `?locale=es` or `?locale=zh-CN`, so the page matches the language of your app.
8 +
9 +### What's new
10 +
11 +- **Choose the language per user.** Append `locale` to the `redirect_url` returned by `session.authorize()` or `connected_accounts.link()` before you send it to the user. Links without the parameter show English, as before.
12 +- **The whole flow stays in one language.** The connect screen and the success or failure screen after the OAuth provider sends the user back all use the language you chose.
13 +- **Other values show English.** The Connect Link accepts `en`, `es`, and `zh-CN` exactly as written. Any other value, including `es-MX`, shows English.
14 +
15 +Field names and help text on API key forms, error details from the provider, and the provider's own sign-in and consent screens keep their original language. See [White-labeling authentication → Language](/docs/authentication/white-labeling-authentication#language) for examples in Python and TypeScript.
docs/content/docs/auth-configuration/white-labeling.mdx
+45
@@ -56,6 +56,51 @@ Text has to stay legible against its background. The editor shows the contrast r
56
57 Prefer to work in code? Flip the **JSON** toggle to edit the theme as a single object you can paste, review, or generate. Your logo and app title stay in the **Branding** tab, since the logo has no JSON representation.
58
59 +### Language
60 +
61 +The Connect Link shows English by default. To show it in your user's language, add a `locale` parameter to the Connect Link URL before you send it to the user. The Connect Link supports these languages:
62 +
63 +| Language | `locale` value |
64 +|----------|----------------|
65 +| English | `en` (default) |
66 +| Spanish | `es` |
67 +| Simplified Chinese | `zh-CN` |
68 +
69 +Use these values exactly as written. Any other value, including variants such as `es-MX` or `zh-cn`, shows English. The language stays the same for the whole flow, including the success or failure screen after the user returns from the OAuth provider.
70 +
71 +<Tabs groupId="language" items={['Python', 'TypeScript']} persist>
72 +<Tab value="Python">
73 +```python
74 +from urllib.parse import urlencode
75 +
76 +connection_request = composio.connected_accounts.link(
77 + user_id="user_123",
78 + auth_config_id="ac_abc",
79 +)
80 +
81 +# Show the Connect Link in Spanish
82 +connect_url = f"{connection_request.redirect_url}?{urlencode({'locale': 'es'})}"
83 +```
84 +</Tab>
85 +<Tab value="TypeScript">
86 +```typescript
87 +import { Composio } from '@composio/core';
88 +const composio = new Composio({ apiKey: 'your_api_key' });
89 +// ---cut---
90 +const connectionRequest = await composio.connectedAccounts.link('user_123', 'ac_abc');
91 +
92 +if (connectionRequest.redirectUrl) {
93 + // Show the Connect Link in Spanish
94 + const connectUrl = new URL(connectionRequest.redirectUrl);
95 + connectUrl.searchParams.set("locale", "es");
96 + console.log(connectUrl.toString());
97 +}
98 +```
99 +</Tab>
100 +</Tabs>
101 +
102 +The `locale` parameter changes only the Connect Link's own text. Field names and help text on API key forms, error details from the provider, and the provider's own sign-in and consent screens keep their original language. If you pass `long_redirect_url`, users go straight to the OAuth provider and never see the Connect Link, so `locale` has no effect.
103 +
104 <Callout type="warn" title="Troubleshooting">
105 - **"Secured by Composio" badge won't go away:** this badge is removed when you use your own OAuth app. See [Using your own OAuth apps](#using-your-own-oauth-apps).
106 - **Logo doesn't appear after uploading:** clear your browser cache or try incognito.
docs/content/docs/authentication/white-labeling-authentication.mdx
+43
@@ -61,6 +61,49 @@ Text has to stay legible against its background. The editor shows the contrast r
61
62 Prefer to work in code? Flip the **JSON** toggle to edit the theme as a single object you can paste, review, or generate. Your logo and app title stay in the **Branding** tab, since the logo has no JSON representation.
63
64 +### Language
65 +
66 +The Connect Link shows English by default. To show it in your user's language, add a `locale` parameter to the Connect Link URL before you send it to the user. The Connect Link supports these languages:
67 +
68 +| Language | `locale` value |
69 +|----------|----------------|
70 +| English | `en` (default) |
71 +| Spanish | `es` |
72 +| Simplified Chinese | `zh-CN` |
73 +
74 +Use these values exactly as written. Any other value, including variants such as `es-MX` or `zh-cn`, shows English. The language stays the same for the whole flow, including the success or failure screen after the user returns from the OAuth provider.
75 +
76 +<Tabs groupId="language" items={['Python', 'TypeScript']} persist>
77 +<Tab value="Python">
78 +```python
79 +from urllib.parse import urlencode
80 +
81 +connection_request = session.authorize("gmail")
82 +
83 +# Show the Connect Link in Spanish
84 +connect_url = f"{connection_request.redirect_url}?{urlencode({'locale': 'es'})}"
85 +```
86 +</Tab>
87 +<Tab value="TypeScript">
88 +```typescript
89 +import { Composio } from '@composio/core';
90 +const composio = new Composio({ apiKey: 'your_api_key' });
91 +const session = await composio.create("user_123");
92 +// ---cut---
93 +const connectionRequest = await session.authorize("gmail");
94 +
95 +if (connectionRequest.redirectUrl) {
96 + // Show the Connect Link in Spanish
97 + const connectUrl = new URL(connectionRequest.redirectUrl);
98 + connectUrl.searchParams.set("locale", "es");
99 + console.log(connectUrl.toString());
100 +}
101 +```
102 +</Tab>
103 +</Tabs>
104 +
105 +The `locale` parameter changes only the Connect Link's own text. Field names and help text on API key forms, error details from the provider, and the provider's own sign-in and consent screens keep their original language.
106 +
107 <Callout type="warn" title="Troubleshooting">
108 - **"Secured by Composio" badge won't go away:** this badge is removed when you use your own OAuth app. See [Using your own OAuth apps](#using-your-own-oauth-apps).
109 - **Logo doesn't appear after uploading:** clear your browser cache or try incognito.