Basecamp 2

Basecamp 2 keeps people on the same page. No matter what your role is, everyone works toward a common goal: finishing a project together.

Status: Preview

Tier: Standard

Version: 1.0.0

Actions:

Name	Summary
PostMessage (integer id, integer projectId, CreateMessage_Request body, [internal]string Content-Type)	Post a message
ListToDoLists (integer id, integer projectId)	List to-do lists
ListProjects (integer id)	List Projects
ListDocuments (integer id, integer projectId)	List Documents
CreateDocument (integer id, integer projectId, CreateDocument_Request body, [internal]string Content-Type)	Create Document
CreateToDo (integer id, integer projectId, integer listId, CreateTo-Do_Request body, [internal]string Content-Type)	Create a to-do
CreateEvent (integer id, integer projectId, CreateEvent_Request body, [internal]string Content-Type)	Create an event
ListAccounts ()	List Accounts

Triggers:

Name	Summary
OnDocumentCreated (integer id, integer projectId)	When a document is created
OnToDoCreated (integer id, integer projectId, integer listId, [internal]string Content-Type)	When a to-do is created
OnEventCreated (integer id, integer projectId, [internal]string Content-Type)	When an event is created

Objects:

Name	Summary
CreateDocument_Request
CreateDocument_Response
CreateEvent_Request
CreateEvent_Response
CreateMessage_Request
CreateMessage_Response
CreateTo-Do_Request
CreateTo-Do_Response
ListAccounts_Response
ListDocumentsResponseItem
ListToDoListsResponseItem

Actions:

PostMessage

Summary: Post a message

Description: Create a new message in a project.

Syntax:

Basecamp2.PostMessage (integer id, integer projectId, CreateMessage_Request body, [internal]string Content-Type)

Parameters:

Name	Type	Summary	Required	Related Action
id	integer (Account Id)	The unique id of the account.	True	ListAccounts
projectId	integer (Project Id)	The unique id of the project.	True	ListProjects
body	CreateMessage_Request		True
Content-Type	string (Content-Type)	Content type.	True

Returns:

Type:CreateMessage_Response

ListToDoLists

Summary: List to-do lists

Description: List all to-do lists for a project.

Syntax:

Basecamp2.ListToDoLists (integer id, integer projectId)

Parameters:

Name

Type

Summary

Required

Related Action

integer

(Account Id)

The unique id of the account.

True

ListAccounts

projectId

integer

(Project Id)

The unique id of the project.

True

ListProjects

Returns:

Type:array of (ListToDoListsResponseItem)

ListProjects

Summary: List Projects

Description: List all projects for account.

Syntax:

Basecamp2.ListProjects (integer id)

Parameters:

Name

Type

Summary

Required

Related Action

integer

(Account Id)

The unique id of the account.

True

ListAccounts

Returns:

Type:array of (ListToDoListsResponseItem)

ListDocuments

Summary: List Documents

Description: List all documents for a project.

Syntax:

Basecamp2.ListDocuments (integer id, integer projectId)

Parameters:

Name

Type

Summary

Required

Related Action

integer

(Account Id)

The unique id of the account.

True

ListAccounts

projectId

integer

(Project Id)

The unique id of the project.

True

ListProjects

Returns:

Type:array of (ListDocumentsResponseItem)

CreateDocument

Summary: Create Document

Description: Create a new document.

Syntax:

Basecamp2.CreateDocument (integer id, integer projectId, CreateDocument_Request body, [internal]string Content-Type)

Parameters:

Name	Type	Summary	Required	Related Action
id	integer (Account Id)	The unique id of the account.	True	ListAccounts
projectId	integer (Project Id)	The unique id of the project.	True	ListProjects
body	CreateDocument_Request		True
Content-Type	string (Content-Type)	Content type.	True

Returns:

Type:CreateDocument_Response

CreateToDo

Summary: Create a to-do

Description: Add a to-do to a to-do list.

Syntax:

Basecamp2.CreateToDo (integer id, integer projectId, integer listId, CreateTo-Do_Request body, [internal]string Content-Type)

Parameters:

Name	Type	Summary	Required	Related Action
id	integer (Account Id)	The unique id of the account.	True	ListAccounts
projectId	integer (Project Id)	The unique id of the project.	True	ListProjects
listId	integer (To-Do List Id)	The unique id of the to-do list.	True	ListToDoLists
body	CreateTo-Do_Request		True
Content-Type	string (Content-Type)	Content type.	True

Returns:

Type:CreateTo-Do_Response

CreateEvent

Summary: Create an event

Description: Create a new scheduled event in a project.

Syntax:

Basecamp2.CreateEvent (integer id, integer projectId, CreateEvent_Request body, [internal]string Content-Type)

Parameters:

Name	Type	Summary	Required	Related Action
id	integer (Account Id)	The unique id of the account.	True	ListAccounts
projectId	integer (Project Id)	The unique id of the project.	True	ListProjects
body	CreateEvent_Request		True
Content-Type	string (Content-Type)	Content type.	True

Returns:

Type:CreateEvent_Response

ListAccounts

Summary: List Accounts

Description: Get the basecamp accounts for this connection.

Syntax:

Basecamp2.ListAccounts ()

Returns:

Type:ListAccounts_Response

Triggers:

Trigger OnDocumentCreated

Summary: When a document is created

Description: Trigger a flow when there is a new document in a project.

Syntax:

Basecamp2.OnDocumentCreated (integer id, integer projectId)

Parameters:

Name

Type

Summary

Required

Related Action

integer

(Account Id)

The unique id of the account.

True

ListAccounts

projectId

integer

(Project Id)

The unique id of the project.

True

ListProjects

Returns:

Type:array of (CreateDocument_Response)

Trigger OnToDoCreated

Summary: When a to-do is created

Description: Trigger a flow when there is a new to-do.

Syntax:

Basecamp2.OnToDoCreated (integer id, integer projectId, integer listId, [internal]string Content-Type)

Parameters:

Name	Type	Summary	Required	Related Action
id	integer (Account Id)	The unique id of the account.	True	ListAccounts
projectId	integer (Project Id)	The unique id of the project.	True	ListProjects
listId	integer (To-Do List Id)	The unique id of the to-do list.	True	ListToDoLists
Content-Type	string (Content-Type)	Content type.	True

Returns:

Type:array of (CreateTo-Do_Response)

Trigger OnEventCreated

Summary: When an event is created

Description: Trigger a flow when there is a new event.

Syntax:

Basecamp2.OnEventCreated (integer id, integer projectId, [internal]string Content-Type)

Parameters:

Name	Type	Summary	Required	Related Action
id	integer (Account Id)	The unique id of the account.	True	ListAccounts
projectId	integer (Project Id)	The unique id of the project.	True	ListProjects
Content-Type	string (Content-Type)	Content type.	True

Returns:

Type:array of (CreateEvent_Response)

CreateDocument_Request

Summary:

Description:

Properties:

Name

Type

Summary

title

string

Title

The title of the document.

content

string

Content

The content of the document.

CreateDocument_Response

Summary:

Description:

Properties:

Name	Type	Summary
content	string Content	The content of the document.
created_at	string(date-time) Created Date	The datetime the document was created at.
id	integer(int32) Id	The unique id of the document.
private	boolean Private	Whether the document is private.
title	string Title	The title of the document.

CreateEvent_Request

Summary:

Description:

Properties:

Name	Type	Summary
summary	string Summary	The summary of the event.
description	string Description	The description of the event.
starts_at	string(date-time) Start Date	The datetime the event starts at.
ends_at	string(date-time) End Date	The datetime the event ends at.
remind_at	string(date-time) Reminder Date	The datetime of the event reminder.

CreateEvent_Response

Summary:

Description:

Properties:

Name	Type	Summary
all_day	boolean All Day	Whether the event is all day.
created_at	string(date-time) Created Date	The datetime the event was created at.
description	string Description	The description of the event.
ends_at	string(date-time) End Time	The datetime of event ends.
id	integer(int32) Id	The unique id of the event.
private	boolean Private	Whether the event is private.
starts_at	string(date-time) Start Date	The datetime the event starts.
summary	string Summary	The summary of the event.
url	string URL	The URL of the event.

CreateMessage_Request

Summary:

Description:

Properties:

Name

Type

Summary

subject

string

Subject

The subject of the message.

content

string

Content

The content of the message.

CreateMessage_Response

Summary:

Description:

Properties:

Name	Type	Summary
content	string Content	The content of the message.
created_at	string(date-time) Created Date	The datetime the message was created.
id	integer(int32) Id	The unique id of the message.
private	boolean Privacy Status	Whether the message is private or not.
subject	string Subject	The subject of the message.

CreateTo-Do_Request

Summary:

Description:

Properties:

Name

Type

Summary

content

string

Content

What the to-do is for.

due_at

string

Due Date

The datetime the to-do is due.

CreateTo-Do_Response

Summary:

Description:

Properties:

Name	Type	Summary
completed	boolean Completed	Whether the to-do is completed.
content	string Content	What the to-do is for.
created_at	string(date-time) Created Date	The datetime the to-do was created.
due_at	string(date-time) Due Date	The datetime the to-do is due.
id	integer(int32) Id	The unique id of the to-do.
private	boolean Private	Whether the to-do is private.
url	string URL	The URL of the to-do list.

ListAccounts_Response

Summary:

Description:

Properties:

Name

Type

Summary

accounts

array of (AccountsItem)

Account

AccountsItem

Summary:

Description:

Properties:

Name

Type

Summary

integer(int32)

Id of the account.

name

string

Name

Name of the account.

ListDocumentsResponseItem

Summary:

Description:

Properties:

Name

Type

Summary

integer(int32)

The unique id of the document.

title

string

Title

The title of the document.

ListToDoListsResponseItem

Summary:

Description:

Properties:

Name

Type

Summary

integer(int32)

The unique id of the to-do list.

name

string

Name

Name of the to-do list.