Skip to content

[PROD-64]Add ClickUp auth provider documentation #404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

jottakka
Copy link
Contributor

🎫 Clickup Ticket - PROD-186

Overview

This PR adds comprehensive documentation for the ClickUp auth provider, following the same structure and style as existing auth provider docs (like Reddit) [one can say almost same words as well ©️ 🦥 ].

Changes Made

New Documentation

  • New auth provider page: pages/home/auth-providers/clickup.mdx
  • Follows the same structure as Reddit auth provider documentation
  • Includes proper Note callout about custom auth provider requirement
  • Comprehensive OAuth setup instructions

ClickUp App Creation Guide

  • Step-by-step instructions for creating ClickUp OAuth apps
  • Correct navigation path: Settings → Apps → Create new app
  • Proper redirect URL configuration for Arcade Cloud
  • No scopes required (ClickUp API doesn't use OAuth scopes)

Configuration Options

  • Dashboard GUI: Complete walkthrough of Arcade Dashboard setup
  • Engine YAML: Self-hosted configuration with environment variables
  • Both paths clearly documented with proper steps

Example Files (with clickup_ prefix)

  • clickup_custom_auth.py: Python OAuth flow implementation
  • clickup_custom_auth.js: JavaScript OAuth flow implementation
  • clickup_custom_tool.py: Real ClickUp API integration example
  • config_provider.engine.yaml: Engine configuration template

- Add comprehensive ClickUp auth provider tutorial at pages/home/auth-providers/clickup.mdx
- Follow same structure and style as existing Reddit auth provider documentation
- Include step-by-step OAuth app creation instructions for ClickUp
- Add both Dashboard GUI and engine.yaml configuration options
- Create example files with clickup_ prefix for better organization:
  - clickup_custom_auth.py: Python OAuth flow example
  - clickup_custom_auth.js: JavaScript OAuth flow example
  - clickup_custom_tool.py: Custom tool with real ClickUp API integration
  - config_provider.engine.yaml: Engine configuration example
- Remove scopes from auth examples (ClickUp API doesn't require scopes)
- Include real ClickUp API request example using /api/v2/team endpoint
- Add proper error handling and response parsing in tool example
@jottakka jottakka self-assigned this Aug 10, 2025
Copy link

vercel bot commented Aug 10, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Project Deployment Preview Comments Updated (UTC)
docs Ready Preview Comment Aug 12, 2025 1:42pm

Co-authored-by: Mateo Torres <[email protected]>
@jottakka jottakka requested a review from EricGustin August 12, 2025 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants