Procedures

Automation procedures in the ClickUp book.

The following documentation is for ClickUp v1.0.0 (BDK).

Ensure that you have installed or connected the ClickUp book and created a new playground before using these automation procedures.

to create a (task) in a (list)

Creates a new task in a list

Input Concepts

Concept	Description	Type	Required	Default Value
list	The list to create the task in	clickup list	Yes	(no default)
task input	The input for the new task	clickup create task input	Yes	(no default)

Output Concepts

Concept	Description	Type
task	The created task	clickup task

Examples

Create a task in a list

get a list from "https://app.clickup.com/123/v/li/123"
use the above as the project
>>>
the string is '{"name": "New Bug found", "description": "A new bug was found, lets fix it"}'
get the string as json
use the above as the new bug
>>>
create a task in the project
    the task input is the new bug

to get a (list) from (list url)

Gets a list from its url

Input Concepts

Concept	Description	Type	Required	Default Value
list url	The URL of the list	text	Yes	(no default)

Output Concepts

Concept	Description	Type
list	The ClickUp list concept	clickup list

Examples

Get a list from a url

get a list from "https://app.clickup.com/123/v/li/123"

to get some (list's tasks)

FILTER - CAPABLE

Gets all tasks in a list

Input Concepts

Concept	Description	Type	Required	Default Value
list	The list to retrieve the tasks from	clickup list	Yes	(no default)

Output Concepts

Concept	Description	Type
list's tasks	The tasks from the list	clickup task

Examples

Get all tasks in a list

get a list from "https://app.clickup.com/123/v/li/123"
use the above as the project
>>>
get the project's tasks

Get a task by name from a list

...
get the project's task whose name is "Task with Different Assignee"

Get tasks in a given status from a list

...
get the project's tasks whose status is "in progress"

to get some (list's users)

FILTER - CAPABLE

Gets the users that have access to a list

Input Concepts

Concept	Description	Type	Required	Default Value
list	The list concept to retrieve the users from	clickup list	Yes	(no default)

Output Concepts

Concept	Description	Type
list's users	The users from the list	clickup user

Examples

Get all users in a list

get a list from "https://app.clickup.com/123/v/li/123"
use the above as the project
>>>
get the project's users

Get a user by name from a list

...
get the project's user whose name is "Integration User"

to update a (task)

Updates an existing task in ClickUp

Input Concepts

Concept	Description	Type	Required	Default Value
task	The task concept with updated fields to apply	clickup task	Yes	(no default)

Output Concepts

Concept	Description	Type
task	The updated task	clickup task

Examples

Update a task

...
use the above as the new task
>>>
the new task's status is "in progress"
>>>
update the new task