Connectors Reference

Asana

Asana enables teams to manage their projects and tasks in one place.

 

Status: Preview

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

ListWorkspaces ()

List workspaces

ListProjects (string workspace)

List projects from workspace

CreateProject (string workspace, ProjectRequest project)

Create new project

GetProject (string project_id)

Get project by ID

ListTasks (string workspace, string project)

List tasks from project

CreateTask (string workspace, string projects, TaskRequest task)

Create Task

GetTask (string task_id)

Get task by ID

CompleteTask (string task_id)

Complete Task

AddComment (string task_id, AddCommentParameterBody body)

Add Comment

ListUsers (string workspace_id)

List users by workspace

GetUser (string user_id)

Get user by ID

 

Triggers:

Name

Summary

OnProjectCreated (string workspace)

When a project is created

OnTaskCreated (string workspace, string project)

When a task is created

OnTaskCompleted (string workspace, string project)

When a task is completed

 

Objects:

Name

Summary

AddCommentParameterBody

 

AddCommentResponse

 

Assignee

Assignee

CreatedBy

Author

CurrentStatus

Status

ListProjectsResponse

 

ListTasksResponse

 

ListUsersResponse

 

ListWorkSpacesResponse

 

Owner

Owner

ProjectRequest

 

ProjectResponse

 

Target

Task

TaskRequest

 

TaskResponse

 

UserResponse

 

WorkSpace

Workspace

 

Actions:

ListWorkspaces

Summary: List workspaces

Description: This operation is used to list workspaces for the current user.

 

Syntax:

Asana.ListWorkspaces ()

 

Returns:

          Type:ListWorkSpacesResponse

 

ListProjects

Summary: List projects from workspace

Description: This operation is used to list projects for the current user.

 

Syntax:

Asana.ListProjects (string workspace)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace

string

(Workspace ID)

Workspace to monitor for new projects.

True

ListWorkspaces

 

Returns:

          Type:ListProjectsResponse

 

CreateProject

Summary: Create new project

Description: This operation is used to create a new project.

 

Syntax:

Asana.CreateProject (string workspace, ProjectRequest project)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace

string

(Workspace ID)

Workspace to use for new projects.

True

ListWorkspaces

project

ProjectRequest

 

An Asana project used to create new projects.

True

 

Returns:

          Type:ProjectResponse

          Description: An Asana project.

 

GetProject

Summary: Get project by ID

Description: This operation retrieves project object by Project ID.

 

Syntax:

Asana.GetProject (string project_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

project_id

string

(Project ID)

The ID of the Project.

True

 

Returns:

          Type:ProjectResponse

          Description: An Asana project.

 

ListTasks

Summary: List tasks from project

Description: This operation returns a list of tasks for a specified project.

 

Syntax:

Asana.ListTasks (string workspace, string project)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace

string

(Workspace ID)

Workspace to monitor for new projects.

True

ListWorkspaces

project

string

(Project)

Project

True

ListProjects

 

Returns:

          Type:ListTasksResponse

 

CreateTask

Summary: Create Task

Description: This operation is used to create a new task in your Asana project.

 

Syntax:

Asana.CreateTask (string workspace, string projects, TaskRequest task)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace

string

(Workspace ID)

Workspace to use for your projects.

True

ListWorkspaces

projects

string

(Project ID)

Project

True

ListProjects

task

TaskRequest

 

An Asana task used to create new tasks.

True

 

Returns:

          Type:TaskResponse

          Description: An Asana task.

 

GetTask

Summary: Get task by ID

Description: This operation retrieves a task object by Task ID.

 

Syntax:

Asana.GetTask (string task_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

task_id

string

(Task ID)

Unique id of the task.

True

 

Returns:

          Type:TaskResponse

          Description: An Asana task.

 

CompleteTask

Summary: Complete Task

Description: This operation is used to mark an existing task as complete.

 

Syntax:

Asana.CompleteTask (string task_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

task_id

string

(Task ID)

Unique id of the task.

True

 

Returns:

          Type:TaskResponse

          Description: An Asana task.

 

AddComment

Summary: Add Comment

Description: This operation is used to add a comment to an existing task.

 

Syntax:

Asana.AddComment (string task_id, AddCommentParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

task_id

string

(Task ID)

Unique id of the task.

True

body

AddCommentParameterBody

 

 

True

 

Returns:

          Type:AddCommentResponse

          Description: A comment on an Asana task.

 

ListUsers

Summary: List users by workspace

Description: This operation retrieves the list of users for a given workspace.

 

Syntax:

Asana.ListUsers (string workspace_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace_id

string

(Workspace ID)

Workspace to monitor for users.

True

ListWorkspaces

 

Returns:

          Type:ListUsersResponse

 

GetUser

Summary: Get user by ID

Description: This operation retrieves user object by User ID.

 

Syntax:

Asana.GetUser (string user_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

user_id

string

(User)

User

True

 

Returns:

          Type:UserResponse

          Description: An Asana user.

 

Triggers:

Trigger OnProjectCreated

Summary: When a project is created

Description: Triggers when a new project is created.

 

Syntax:

Asana.OnProjectCreated (string workspace)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace

string

(Workspace ID)

Workspace to monitor for new projects.

True

ListWorkspaces

 

Returns:

          Type:ListProjectsResponse

 

Trigger OnTaskCreated

Summary: When a task is created

Description: Triggers when a new task is created.

 

Syntax:

Asana.OnTaskCreated (string workspace, string project)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace

string

(Workspace ID)

Workspace to monitor for new projects.

True

ListWorkspaces

project

string

(Project ID)

Project

True

ListProjects

 

Returns:

          Type:ListTasksResponse

 

Trigger OnTaskCompleted

Summary: When a task is completed

Description: Triggers when an existing task is completed.

 

Syntax:

Asana.OnTaskCompleted (string workspace, string project)

 

Parameters:

Name

Type

Summary

Required

Related Action

workspace

string

(Workspace ID)

Workspace to monitor for new projects.

True

ListWorkspaces

project

string

(Project ID)

Project

True

ListProjects

 

Returns:

          Type:ListTasksResponse

 


 

AddCommentParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

Data

 

 

 

Data

Summary:

Description:

 

          Properties:

Name

Type

Summary

text

string

Comment

Text to be used as comment.

 


 

AddCommentResponse

Summary:

Description: A comment on an Asana task.

 

          Properties:

Name

Type

Summary

data

Data

 

A comment on an Asana task.

 

Data

Summary:

Description: A comment on an Asana task.

 

          Properties:

Name

Type

Summary

target

Target

Task

The task that this comment is associated with.

text

string

Text

The text of the comment.

created_at

string

Creation date

The date and time at which this comment was created.

created_by

CreatedBy

Author

The user that authored this comment.

source

string

Source

The component of the Asana product the user used to trigger the comment.

type

string

Type

The type of comment this is.

id

integer(int32)

Comment ID

The ID for this comment.

 


 

Assignee

Summary: Assignee

Description: The user to whom this task is assigned.

 

          Properties:

Name

Type

Summary

id

integer

ID

 

name

string

name

 


 

CreatedBy

Summary: Author

Description: The user that authored this comment.

 

          Properties:

Name

Type

Summary

id

integer

ID

The ID of the user that authored this comment.

name

string

name

The name of the user that authored this comment.


 

CurrentStatus

Summary: Status

Description:

 

          Properties:

Name

Type

Summary

color

string

color

The color status of the project.

text

string

text

Text describing the project status.

author

Author

 

author.

 

Author

Summary:

Description: author.

 

          Properties:

Name

Type

Summary

id

integer

ID

ID of the author of the project status.

name

string

name

Name of the author of the project status.

 


 

ListProjectsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (ProjectResponse)

Projects

 


 

ListTasksResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (TaskResponse)

Tasks

 


 

ListUsersResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (UserResponse)

Users

 


 

ListWorkSpacesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (DataItem)

 

 

 

DataItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Workspace ID

Unique identifier of the workspace.

name

string

Name

Workspace name.

is_organization

boolean

 

 

 


 

Owner

Summary: Owner

Description: The project owner.

 

          Properties:

Name

Type

Summary

id

integer

ID

The ID of the project owner.

name

string

name

The name of the project owner.


 

ProjectRequest

Summary:

Description: An Asana project used to create new projects.

 

          Properties:

Name

Type

Summary

data

Data

 

An Asana project used to create new projects.

 

Data

Summary:

Description: An Asana project used to create new projects.

 

          Properties:

Name

Type

Summary

name

string

Project name

Name of the project.

due_date

string(date)

Due date

yyyy-MM-dd

public

boolean

Public

True if the project is public to the organization.

color

string

Project color

Color used to display the project.  Values: [dark-pink, dark-green, dark-blue, dark-red, dark-teal, dark-brown, dark-orange, dark-purple, dark-warm-gray, light-pink, light-green, light-blue, light-red, light-teal, light-yellow, light-orange, light-purple, light-warm-gray]

notes

string

Project notes

Notes about the project.

owner

string

Owner

Owner of the project.

archived

boolean

Archive

Archived projects do not show in the UI by default.

 


 

ProjectResponse

Summary:

Description: An Asana project.

 

          Properties:

Name

Type

Summary

id

integer(int32)

Project ID

 

name

string

Project name

 

notes

string

Project notes

 

created_at

string(date-time)

Created date

yyyy-MM-ddTHH:mm:ss.fffZ

modified_at

string(date-time)

Modified date

yyyy-MM-ddTHH:mm:ss.fffZ

owner

Owner

Owner

The project owner.

due_date

string(date)

Due date

yyyy-MM-dd

current_status

CurrentStatus

Status

 

public

boolean

Public

 

archived

boolean

Archived

 

workspace

WorkSpace

Workspace

The workspace.

color

string

Color

Project color.


 

Target

Summary: Task

Description: The task that this comment is associated with.

 

          Properties:

Name

Type

Summary

id

integer

ID

The ID of the task that this comment is associated with.

name

string

name

The ID of the task that this comment is associated with.


 

TaskRequest

Summary:

Description: An Asana task used to create new tasks.

 

          Properties:

Name

Type

Summary

data

Data

 

An Asana task used to create new tasks.

 

Data

Summary:

Description: An Asana task used to create new tasks.

 

          Properties:

Name

Type

Summary

name

string

Task name

Name of the task.

assignee

string

Assignee

'Email or User ID, defaults to current user.

notes

string

Description

Description of the task.

assignee_status

string

Assignee status

Scheduling status of the task.  Values: [Inbox, Later, Today, Upcoming]

completed

boolean

Completed

Indicate if the task will be marked as completed.

due_on

string(date)

Due date

Due date of the task.

 


 

TaskResponse

Summary:

Description: An Asana task.

 

          Properties:

Name

Type

Summary

id

integer(int32)

Task ID

 

created_at

string(date-time)

Created date

yyyy-MM-ddTHH:mm:ss.fffZ

modified_at

string(date-time)

Modified date

yyyy-MM-ddTHH:mm:ss.fffZ

name

string

Task name

 

notes

string

Task notes

 

completed

boolean

Completed

 

assignee

Assignee

Assignee

The user to whom this task is assigned.

assignee_status

string

Asignee status

Scheduling status of the task.

completed_at

string(date-time)

Completed date and time

yyyy-MM-ddTHH:mm:ss.fffZ

due_on

string(date)

Due date

yyyy-MM-dd

due_at

string

Due date and time

yyyy-MM-ddTHH:mm:ss.fffZ

workspace

WorkSpace

Workspace

The workspace.

num_hearts

integer(int32)

Number of likes

 

hearted

boolean

Liked

 


 

UserResponse

Summary:

Description: An Asana user.

 

          Properties:

Name

Type

Summary

id

integer(int32)

User ID

 

name

string

User name

 

email

string

Email

 


 

WorkSpace

Summary: Workspace

Description: The workspace.

 

          Properties:

Name

Type

Summary

id

integer

ID

 

name

string

name