Skip to content

Commit 020db29

Browse files
devin-ai-integration[bot]khaliqgantlordsarcastic
authored
docs: add ClickUp integration setup guide (ext-393) (#3746)
# ClickUp Integration Documentation This PR adds comprehensive documentation for the ClickUp integration, including a detailed setup guide for creating and configuring OAuth credentials. ## Changes - Added complete setup guide with step-by-step instructions - Updated access requirements section - Reformatted useful links into a table for better readability - Enhanced API gotchas section with important considerations ## References - [ClickUp API Documentation](https://developer.clickup.com/docs) - [ClickUp Authentication Documentation](https://developer.clickup.com/docs/authentication) - [ClickUp OAuth Flow](https://developer.clickup.com/docs/authentication#build-apps-for-others---oauth-flow) - [ClickUp OAuth Endpoints](https://developer.clickup.com/reference/getaccesstoken) Link to Devin run: https://app.devin.ai/sessions/94f14c04f0bf4a7bb75ab740686940de Requested by: khaliq@nango.dev <!-- Summary by @propel-code-bot --> --- This PR significantly expands the ClickUp integration documentation by providing a detailed, step-by-step OAuth setup guide, clarifying access requirements, and reformatting and enriching reference links and API gotchas. The update replaces placeholders and previous incomplete content with actionable instructions on app registration, OAuth credential management, and integration steps with Nango, while also addressing API behaviors specific to ClickUp (e.g., scope handling and workspace authorization). Older notes, duplicate sections, and unnecessary imports were removed for clarity. **Key Changes:** • Added a comprehensive, multi-step ClickUp OAuth setup guide using <Steps> and <Step> components. • Clarified the access requirements table (noting free accounts and lack of review/audit needs). • Replaced and expanded useful links with a clear list of authoritative API documentation and endpoints. • Expanded the API gotchas section to explain scope handling and workspace/authorization nuances. • Removed placeholders, outdated notes, and unnecessary import lines. **Affected Areas:** • docs-v2/integrations/all/clickup.mdx *This summary was automatically generated by @propel-code-bot* --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: khaliq@nango.dev <khaliq@nango.dev> Co-authored-by: lordsarcastic <adeoti.15.jude@gmail.com>
1 parent a7c1e63 commit 020db29

File tree

1 file changed

+77
-14
lines changed

1 file changed

+77
-14
lines changed

‎docs-v2/integrations/all/clickup.mdx

Lines changed: 77 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,32 +14,95 @@ import PreBuiltUseCases from "/snippets/generated/clickup/PreBuiltUseCases.mdx"
1414
## Access requirements
1515
| Pre-Requisites | Status | Comment|
1616
| - | - | - |
17-
| Paid dev account | ❓ | |
18-
| Paid test account | ❓ | |
19-
| Partnership | ❓ | |
20-
| App review | ❓ | |
21-
| Security audit | ❓ | |
17+
| Paid dev account | ✅ Not required | Free ClickUp account is sufficient for development. |
18+
| Paid test account | ✅ Not required | Free ClickUp account is sufficient for testing. |
19+
| Partnership | ✅ Not required | |
20+
| App review | ✅ Not required | No review process for OAuth apps. |
21+
| Security audit | ✅ Not required | |
2222

2323

2424
## Setup guide
2525

26-
_No setup guide yet._
26+
<Steps>
27+
<Step title="Create a ClickUp account">
28+
1. If you don't already have a ClickUp account, go to [ClickUp's signup page](https://app.clickup.com/signup) and create one.
29+
2. Sign in to your ClickUp account.
30+
</Step>
31+
32+
<Step title="Create a new OAuth app">
33+
1. In the upper-right corner, click on your avatar.
34+
2. Select **Settings** from the dropdown menu.
35+
3. In the sidebar, click on **Apps**.
36+
4. Click the **Create new app** button.
37+
38+
Note: Only Workspace owners or admins can create OAuth apps.
39+
</Step>
40+
41+
<Step title="Configure your OAuth application">
42+
Fill in the required fields:
43+
44+
1. **App name**: Enter a name for your application.
45+
2. **Redirect URL**: Enter `https://api.nango.dev/oauth/callback`
46+
47+
This is the URL where ClickUp will redirect users after they authorize your application.
48+
</Step>
49+
50+
<Step title="Obtain your OAuth credentials">
51+
After creating your app, you'll receive:
52+
53+
- **Client ID**: A unique identifier for your application
54+
- **Client Secret**: A secret key for your application
55+
56+
Make sure to store these securely, especially the Client Secret, as you'll need them when configuring your integration in Nango.
57+
</Step>
58+
59+
<Step title="Configure your integration in Nango">
60+
When setting up your ClickUp integration in Nango:
61+
62+
- Use your **Client ID** and **Client Secret** from the previous step
63+
- For the authorization URL, use: `https://app.clickup.com/api`
64+
- For the token URL, use: `https://api.clickup.com/api/v2/oauth/token`
65+
66+
Note: ClickUp does not use scopes in their OAuth implementation, so you can leave the scope field empty.
67+
</Step>
68+
69+
<Step title="Understand the OAuth flow">
70+
The ClickUp OAuth flow follows these steps:
71+
72+
1. Users are redirected to ClickUp's authorization page: `https://app.clickup.com/api?client_id={client_id}&redirect_uri={redirect_uri}`
73+
2. Users log in to ClickUp and select which Workspaces to authorize for your app
74+
3. After authorization, users are redirected back to your redirect URL with an authorization code
75+
4. Your application exchanges this code for an access token using the token endpoint
76+
</Step>
77+
78+
<Step title="Test the OAuth flow">
79+
1. After configuring your integration in Nango, test the OAuth flow to ensure it works correctly.
80+
2. The authorization flow will redirect users to ClickUp where they can approve access to their Workspaces.
81+
3. After approval, users will be redirected back to your application with an authorization code.
82+
4. This code will be exchanged for an access token that can be used to make API requests.
83+
</Step>
84+
85+
<Step title="Next">
86+
Follow the [_Quickstart_](/getting-started/quickstart).
87+
</Step>
88+
</Steps>
2789

2890
<Tip>Need help getting started? Get help in the [community](https://nango.dev/slack).</Tip>
2991

30-
<Note>Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/clickup.mdx)</Note>
31-
3292

3393
## Useful links
3494

35-
- [How to register an Application](https://clickup.com/api/developer-portal/authentication#step-1-create-an-oauth-app)
36-
- [OAuth-related docs](https://clickup.com/api/developer-portal/authentication#oauth-flow)
37-
- [Web API docs (their REST API)](https://clickup.com/api/clickupreference/operation/CreateTaskAttachment/)
38-
39-
<Note>Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/clickup.mdx)</Note>
95+
- [ClickUp API Documentation](https://developer.clickup.com/docs)
96+
- [ClickUp API Reference](https://developer.clickup.com/reference)
97+
- [OAuth Flow](https://developer.clickup.com/docs/authentication#build-apps-for-others---oauth-flow)
98+
- [OAuth Endpoints](https://developer.clickup.com/reference/getaccesstoken)
99+
- [API v2 and v3 Terminology](https://developer.clickup.com/docs/general-v2-v3-api)
40100

41101
## API gotchas
42102

43-
- You can leave the scopes empty as scopes are not required during authorization.
103+
- ClickUp does not use scopes in their OAuth implementation, so you can leave the scope field empty when configuring your integration.
104+
105+
- Users can authorize one or more Workspaces for your application. Use the [Get Authorized Teams (Workspaces)](https://developer.clickup.com/reference/getauthorizedteams) endpoint to see which Workspaces are authorized.
106+
44107

45108
<Note>Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/clickup.mdx)</Note>

0 commit comments

Comments
 (0)