About the ClickUp category

o.plokha · October 17, 2024, 10:26am

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: ClickUp API Reference

Connector package documentation

1. Setting up HTTP Client ClickUp

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
Select ClickUp HTTP Client as PlatForm and click next step
Fill in the Base URI
Select the Authentication Type
- Basic Authentication
  - Fill in the Personal Token
    (See the ClickUp Token Authentication Documentation for more information)
- Oauth 2.0 Authentication
  - Fill in the Token URL, Authorize URL, Client ID and Client Secret.
  - Click on “Grant access to ClickUp” and you will be redirected to ClickUp website to get the key for the client.
    (See the ClickUp Oauth 2.0 Authentication Documentation
You can optionally enable logging of request to get the log of the authentication.
Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use.

2. Subscribing to Entities from ClickUp

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select “ClickUp Subscriber” as the subscriber.
Select the entity you want to subscribe to from ClickUp.
Add any request parameters needed to subscribe to the entity.
Select the ClickUp HTTP Client to use.
You can optionally add a transformer to transform the request parameters into something you will request from ClickUp.
You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

We follow ClickUp documentation on building this connector, so you can easily use the connector based on ClickUp API Reference.

Entity

The entity you want to subscribe to ClickUp. Please refer to the entities from ClickUp 2.0 API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the ClickUp API Reference.

Please look at the example below on how to fill path field when we want retrieve list of task by subscribing “Tasks - Get Tasks” entity.

From the end point, we can see that we need to set the list id as parameters. That is why we set the “list_id” inside the path key in the Request Parameters.

Alumio will then make a request to ClickUp with the URL /v2/list/901803781168/task

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0

HTTP Client

The HTTP Client configuration you will use to access ClickUp.

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select “ClickUp Publisher” as the publisher.
Select the Method that you want the publisher to perform with the data.
Select the ClickUp entity you want the data to be published to.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.
Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.

Method

Currently, we support HTTP Post method, HTTP Put method and HTTP Delete method on submitting data to ClickUp.

Entity

We support publishing to all ClickUp 2.0 endpoints.
Please refer to ClickUp API Reference page.

For example, we want to update a task. Please select “Put” as the Method and “Tasks - Update a Task”.

From the documentation, we can see that we need to set a path parameter and a body parameters. That is why we set the “task_id” inside the path key and body parameters inside the payload key in the data.

Alumio will send an API request to ClickUp with URL https://api.clickup.com/api/v2/task/86eqhgatq

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0
Payload is the data contained within a request.