> ## Documentation Index
> Fetch the complete documentation index at: https://botpress.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Asana

{/* vale on */}

[Open in Hub](https://studio.botpress.cloud/home?exploreHub=1\&hubItemId=intver_01KMZACD2E15B0RZB8RJ2XN2JX)
*v0.3.13*

Asana Integration allows you to seamlessly connect your Botpress and Asana, a well-established project management platform. This integration equips your bot with the ability to manage projects and tasks right from its interface. After the setup, you will be able to perform actions such as task creation, task updates, task comment addition, and more.

## Prerequisites

* An [Asana account](https://asana.com/)
* Access to an existing Asana workspace.

## Setting up the Asana integration in Botpress

1. Go to the [Integration Hub](https://app.botpress.cloud/hub) in Botpress Cloud (if you don't have the integration installed yet).
2. Find and open the Asana integration then click on the "Install to Bot" button, now go back to your bot settings.

The Asana integration has the following settings:

* **Enabled**: Whether Botpress will communicate with Asana
* **Webhook URL**: The URL for receiving data in Botpress. (You shall not be using it)
* **API Token**: The API token generated from Asana
* **Workspace Gid**: The workspace ID obtained from Asana

## Setting up Asana

1. Generate a Personal Access Token on Asana. Follow [these instructions](https://developers.asana.com/docs/personal-access-token) to get your token. Once you have it, paste it in the API Token input in Botpress.
2. Get the workspace ID. You can obtain your workspace ID by visiting [this link](https://app.asana.com/api/1.0/workspaces) while logged in to your Asana account. The workspace ID corresponds to the `gid` parameter of the workspace you want to use. Paste it in the Workspace Gid input in Botpress.

That's it! Now the Asana integration is operational and ready for use within your bot.

> [!NOTE]
>
> Note
>
> The Asana API rate limits are applicable. Also, note that certain advanced Asana features tied to paid plans may not be accessible.

With the Asana Integration, you can interact with Asana directly from your Botpress bot. The integration introduces various actions, including task creation, task updates, task comment addition, and more, making the task and user management processes more efficient.

***

## Cards

{/* vale off */}

Here's a reference for all [Cards](https://botpress.com/docs/studio/concepts/cards/introduction.md) available with the integration:

### Add Comment to Task

Add Comment to Task, by task ID

**input** `object`

**taskId** `string` *required*

Task ID to comment

**comment** `string` *required*

Content of the comment to be added

**output** `object`

**text** `string` *required*

The text of the comment

### Create Task

Create Task

**input** `object`

**name** `string` *required*

The name of the task (e.g. "My Test Task")

**notes** `string`

The description of the task (Optional) (e.g. "This is my other task created using the Asana API")

**assignee** `string` (default: me)

The ID of the user who will be assigned to the task or "me" to assign to the current user (Optional) (e.g. "1215207682932839") (Default: "me")

**projects** `string`

The project IDs should be strings separated by commas (Optional) (e.g. "1205199808673678, 1215207282932839").

**parent** `string`

The ID of the parent task (Optional) (e.g. "1205206556256028")

**start\_on** `string`

The start date of the task in YYYY-MM-DD format (Optional) (e.g. "2023-08-13")

**due\_on** `string`

The due date of the task without a specific time in YYYY-MM-DD format (Optional) (e.g. "2023-08-15")

**output** `object`

**permalink\_url** `string` *required*

The permalink url

### Find User

Find User by userId

**input** `object`

**userEmail** `string` *required*

User Email (e.g. "[mrsomebody@example.com](mailto:mrsomebody@example.com)")

**output** `object`

**gid** `string`

The GID of the User

**name** `string`

The name of the user

**email** `string`

The email of the user

**photo** `object | null`

**resource\_type** `string`

The resource type of the user

**workspaces** `array`

List of the workspaces

**array item properties**

**gid** `string` *required*

The GID of the workspace

**name** `string` *required*

The name of the workspace

**resource\_type** `string` *required*

The resource type of the workspace

### Update Task

Update Task by taskId

**input** `object`

**name** `string`

The name of the task (Optional) (e.g. "My Test Task")

**notes** `string`

The description of the task (Optional) (e.g. "This is my other task created using the Asana API")

**assignee** `string`

The ID of the user who will be assigned to the task or "me" to assign to the current user (Optional) (e.g. "1215207682932839")

**start\_on** `string`

The start date of the task in YYYY-MM-DD format (Optional) (e.g. "2023-08-13")

**due\_on** `string`

The due date of the task without a specific time in YYYY-MM-DD format (Optional) (e.g. "2023-08-15")

**taskId** `string` *required*

Task ID to update

**completed** `string`

If the task is completed, enter "true" (without quotes), otherwise it will keep its previous status. (Optional)

**output** `object`

**permalink\_url** `string` *required*

The permalink url


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.