Add ClickUp node docs

This commit is contained in:
Tanay Pant
2020-07-12 09:02:35 +02:00
parent 9c2ce882d9
commit 4c37c9b45f
3 changed files with 100 additions and 11 deletions

View File

@@ -1,34 +1,34 @@
# Clickup
# ClickUp
You can find information about the operations supported by the Clickup node on the [integrations](https://n8n.io/integrations/n8n-nodes-base.clickup) page. You can also browse the source code of the node on [GitHub](https://github.com/n8n-io/n8n/tree/master/packages/nodes-base/nodes/Clickup).
You can find information about the operations supported by the ClickUp node on the [integrations](https://n8n.io/integrations/n8n-nodes-base.clickup) page. You can also browse the source code of the node on [GitHub](https://github.com/n8n-io/n8n/tree/master/packages/nodes-base/nodes/Clickup).
## Prerequisites
Create a [Clickup](https://www.clickup.com/) account.
Create a [ClickUp](https://www.clickup.com/) account.
## Using OAuth
1. Open your Clickup dashboard.
1. Open your ClickUp dashboard.
2. Click on your profile icon in the bottom left.
3. Click on "Settings" under your workspace profile.
4. Click on "Integrations".
5. Click on "Clickup API".
5. Click on "ClickUp API".
6. Click on Create app.
7. Enter in App name and redirect URL(s).
8. Use Client ID and client Secret key in your Clickup node credentials in n8n.
9. Enter n8n provided redirect URL in configuration. ![Redirect URL Explanation here](../README.md).
8. Use Client ID and client Secret key in your ClickUp node credentials in n8n.
9. Enter n8n provided redirect URL in configuration. Redirect URL Explanation [here](../README.md).
![Getting Clickup credentials](./using-oauth.gif)
![Getting ClickUp credentials](./using-oauth.gif)
## Using Access Token
1. Open your Clickup dashboard.
1. Open your ClickUp dashboard.
2. Click on your profile icon in the bottom left.
3. Click on "Apps".
4. Click on "Generate" under API token.
5. Use selected API key in your Clickup node credentials in n8n.
5. Use selected API key in your ClickUp node credentials in n8n.
![Getting Clickup credentials](./using-access-token.gif)
![Getting ClickUp credentials](./using-access-token.gif)

View File

@@ -0,0 +1,89 @@
---
permalink: /nodes/n8n-nodes-base.clickUp
---
# ClickUp
[ClickUp](https://clickup.com/) is a cloud-based collaboration and project management tool suitable for businesses of all sizes and industries. Features include communication and collaboration tools, task assignments and statuses, alerts and a task toolbar.
::: tip 🔑 Credentials
You can find authentication information for this node [here](../../../credentials/ClickUp/README.md).
:::
## Basic Operations
- Checklist
- Create a checklist
- Delete a checklist
- Update a checklist
- Checklist item
- Create a checklist item
- Delete a checklist item
- Update a checklist item
- Comment
- Create a comment
- Delete a comment
- Get all comments
- Update a comment
- Folder
- Create a folder
- Delete a folder
- Get a folder
- Get all folders
- Update a folder
- Goal
- Create a goal
- Delete a goal
- Get a goal
- Get all goals
- Update a goal
- Goal Key Result
- Create a key result
- Delete a key result
- Update a key result
- List
- Create a list
- Retrieve list's custom fields
- Delete a list
- Get a list
- Get all lists
- Update a list
- Task
- Create a task
- Delete a task
- Get a task
- Get all tasks
- Set a custom field
- Update a task
- Task Dependency
- Create a task dependency
- Delete a task dependency
- Time Tracking
- Log time on task
- Delete a logged time
- Get all logging times on task
- Update a logged time
## Example Usage
This workflow allows you to create a task in ClickUp. You can also find the [workflow](https://n8n.io/workflows/485) on the website. This example usage workflow would use the following two nodes.
- [Start](../../core-nodes/Start/README.md)
- [ClickUp]()
The final workflow should look like the following image.
![A workflow with the ClickUp node](./workflow.png)
### 1. Start node
The start node exists by default when you create a new workflow.
### 2. ClickUp node
1. First of all, you'll have to enter credentials for the ClickUp node. You can find out how to do that [here](../../../credentials/ClickUp/README.md).
2. Select your team ID from the *Team ID* dropdown list.
3. Select your space ID from the *Space ID* dropdown list.
4. Select your folder ID from the *Folder ID* dropdown list.
5. Select your list ID from the *List ID* dropdown list.
6. Enter the name of the task in the *Name* field.
7. Click on *Execute Node* to run the workflow.

Binary file not shown.

After

Width:  |  Height:  |  Size: 220 KiB