Create your own app with the ClickUp API

Estamos trabalhando na tradução dos nossos artigos da central de ajuda. Você também pode acessar nossa central de ajuda em inglês ou entrar em contato conosco para dar um feedback.

Want to create an app that integrates with ClickUp? Give your users the ability to sign in using OAuth 2.0! 
Be sure to also check out our API documentation!

What you'll need

OAuth 2 flow

When you want to develop an application that others can use, you must use an OAuth2 authentication flow.
With OAuth 2 everyone that uses your app gets assigned an individualized token. Each user can only access the content available to their individual ClickUp user account.
Tip: If you are unfamiliar with OAuth2, Digital Ocean has put together a great guide that should get you started. We also recommend checking out OAuth's website for additional details.

Create an app

The first step for using OAuth 2 is to create an app in your Workspace.
You must be a Workspace owner or admin to manage integration settings. To do so:
  1. In the lower-left corner, click your Workspace avatar.
  2. Select Integrations.
  3. Click ClickUp API.
  4. Enter your app's name and a redirect URL(s).
    • Tip: Not sure what to use for your redirect URL? Check out this guide on OAuth's website.
  5. Click Create App.
  6. On the next screen, you'll see a Client ID and Client Secret have been generated.
  7. Use the Client ID and Client Secret in your app to create an OAuth 2 authentication flow.

Screenshot of the app' modal using OAuth2.

Update your redirect URLs

Have a new redirect URL? You can update these settings in your ClickUp Workspace at any time.
  1. In the lower-left corner, click your Workspace avatar.
  2. Select Integrations.
  3. Click ClickUp API.
  4. Expand the App to show its details.
  5. Update your app:
    • Add or update the redirect URLs.
    • Click Save.

View or regenerate your client secret

Want to regenerate your Client Secret? You can do so at any time.
  1. Click your Workspace avatar in the lower-left corner
  2. Select Integrations
  3. Click ClickUp API
  4. Expand the App to show its details
  5. Click Show to view your current Client Secret
  6. Click Regenerate to immediately create a new Client Secret
  7. Update your App to use the new Client Secret

Authorization token types

Tokens permit you to make API calls and integrate with other applications. You can also use apps like Make to create integrations without writing code. Tokens are specific to your ClickUp user account.
Anyone with a ClickUp account can generate a personal token. Personal tokens permit access to every Workspace your account has created or joined. Your personal token gives you the same access that you have through a web browser.
If you use OAuth2, you can choose to authorize access to specific Workspaces when you first authenticate or when you re-authenticate later.
Screenshot of someone selecting which Workspaces to authorize with OAuth2.

Esse artigo foi útil?