Connectors Reference

Basecamp 3

Basecamp 3 is a tool that helps teams work together. It provides a dashboard to manage all messaging, document collaboration, scheduling and task management together in one place.

 

Status: Preview

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

ListAccounts ()

List Accounts

ListBasecamps (integer account_id)

List Basecamps

ListToDoLists (integer account_id, [Optional]string bucket)

List to-do lists

CreateToDo (integer account_id, string basecampId, string todolistId, NewToDo to-do)

Create a to-do

ListToDos (integer account_id, string basecampId, string todolistId)

List to-dos

CompleteToDo (integer account_id, string basecampId, string todoId)

Complete a to-do

UncompleteToDo (integer account_id, string basecampId, string todoId)

Uncomplete a to-do

DeleteToDo (integer account_id, string basecampId, string todoId)

Delete a to-do

DeleteScheduledEntry (integer account_id, string basecampId, string eventId)

Delete a scheduled entry

DeleteDocument (integer account_id, string basecampId, string documentId)

Delete a document

PostMessage (integer account_id, string basecampId, NewMessage message)

Post a message

ListAllRootFolders (integer account_id, string basecampId)

Gets the root folder for the file picker

ListFolder (integer account_id, string basecampId, string id)

List sub folders for file picker

CreateDocument (integer account_id, string basecampId, string vaultId, NewDocument document)

Create a document

UploadFile (integer account_id, string basecampId, string vaultId, string content_type, string name, string body)

Upload file

CreateScheduleEntry (integer account_id, string basecampId, NewEntry scheduleEntry)

Create a schedule entry

 

Triggers:

Name

Summary

OnMessagePosted (integer account_id, string basecampId)

When a message is posted

OnToDoCreated (integer account_id, string basecampId, string todolistId)

When a to-do is created

OnToDoUpdated (integer account_id, string basecampId, string todolistId)

When a to-do is updated

OnDocumentCreated (integer account_id, string basecampId, string vaultId)

When a document is created

OnDocumentUpdated (integer account_id, string basecampId, string vaultId)

When a document is updated

OnDocumentDeleted (integer account_id, [Optional]string bucket)

When a document is deleted

OnScheduledEntryDeleted (integer account_id, [Optional]string bucket)

When a schedule entry is deleted

OnFileUploaded (integer account_id, string basecampId, string vaultId)

When a file is uploaded

OnFileUpdated (integer account_id, string basecampId, string vaultId)

When a file is updated

OnScheduledEntryCreated (integer account_id, string basecampId)

When a schedule entry is created

OnScheduledEntryUpdated (integer account_id, string basecampId)

When a schedule entry is updated

 

Objects:

Name

Summary

Account

 

AccountList

Accounts

Basecamp

 

BlobMetaData

 

DockItem

Dock item

Document

Document

Entry

Schedule entry

Message

Message

NewDocument

New document

NewEntry

New schedule entry

NewMessage

New message

NewToDo

To-do

ToDo

To-do

ToDoList

To-do list

Upload

Upload

 

Actions:

ListAccounts

Summary: List Accounts

Description: List Accounts you're a part of

 

Syntax:

Basecamp3.ListAccounts ()

 

Returns:

          Type:AccountList

          Summary: Accounts

          Description: A list of Accounts

 

ListBasecamps

Summary: List Basecamps

Description: List Basecamps you're a part of

 

Syntax:

Basecamp3.ListBasecamps (integer account_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

 

Returns:

          Type:array of (Basecamp)

          Summary: Basecamps

          Description: A list of Basecamps

 

ListToDoLists

Summary: List to-do lists

Description: List the to-do lists in the basecamp

 

Syntax:

Basecamp3.ListToDoLists (integer account_id, [Optional]string bucket)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

bucket

string

(Basecamp)

Basecamp to filter on

False

ListBasecamps

 

Returns:

          Type:array of (ToDoList)

          Summary: To-do lists

          Description: The to-do lists in the Basecamp

 

CreateToDo

Summary: Create a to-do

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

 

Syntax:

Basecamp3.CreateToDo (integer account_id, string basecampId, string todolistId, NewToDo to-do)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

todolistId

string

(To-do list)

Unique identifier of the to-do list.

True

ListToDoLists

to-do

NewToDo

(To-do)

A To-do in a To-do List

True

 

Returns:

          Type:ToDo

          Summary: To-do

          Description: A To-do from a To-do List

 

ListToDos

Summary: List to-dos

Description: List the to-dos in a to-do list

 

Syntax:

Basecamp3.ListToDos (integer account_id, string basecampId, string todolistId)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

todolistId

string

(To-do list)

Unique identifier of the to-do list.

True

ListToDoLists

 

Returns:

          Type:array of (ToDo)

          Summary: To-dos

          Description: The top 50 active items in the to-do list

 

CompleteToDo

Summary: Complete a to-do

Description: Mark a to-do as completed

 

Syntax:

Basecamp3.CompleteToDo (integer account_id, string basecampId, string todoId)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

todoId

string

(To-do Id)

Get a To-do Id from a previous step

True

 

Returns:

 

UncompleteToDo

Summary: Uncomplete a to-do

Description: Mark a to-do as not completed

 

Syntax:

Basecamp3.UncompleteToDo (integer account_id, string basecampId, string todoId)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

todoId

string

(To-do Id)

Get a To-do Id from a previous step

True

 

Returns:

 

DeleteToDo

Summary: Delete a to-do

Description: Put a to-do in the trash

 

Syntax:

Basecamp3.DeleteToDo (integer account_id, string basecampId, string todoId)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

todoId

string

(To-do Id)

Get a To-do Id from a previous step

True

 

Returns:

 

DeleteScheduledEntry

Summary: Delete a scheduled entry

Description: Put a scheduled entry in the trash

 

Syntax:

Basecamp3.DeleteScheduledEntry (integer account_id, string basecampId, string eventId)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

eventId

string

(Scheduled entry Id)

Get a scheduled entry Id from a previous step

True

 

Returns:

 

DeleteDocument

Summary: Delete a document

Description: Put a document in the trash

 

Syntax:

Basecamp3.DeleteDocument (integer account_id, string basecampId, string documentId)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

documentId

string

(Document Id)

Get a document Id from a previous step

True

 

Returns:

 

PostMessage

Summary: Post a message

Description: Add a message to a basecamp

 

Syntax:

Basecamp3.PostMessage (integer account_id, string basecampId, NewMessage message)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

message

NewMessage

(New message)

A message to post to a basecamp

True

 

Returns:

          Type:Message

          Summary: Message

          Description: A message posted to a basecamp

 

ListAllRootFolders

Summary: Gets the root folder for the file picker

Description: Gets the root folder for the file picker

 

Syntax:

Basecamp3.ListAllRootFolders (integer account_id, string basecampId)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

 

Returns:

          Type:array of (BlobMetaData)

 

ListFolder

Summary: List sub folders for file picker

Description: List sub folders for file picker

 

Syntax:

Basecamp3.ListFolder (integer account_id, string basecampId, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

id

string

(Root Folder)

The id of the parent folder

True

 

Returns:

          Type:array of (BlobMetaData)

 

CreateDocument

Summary: Create a document

Description: Add a document

 

Syntax:

Basecamp3.CreateDocument (integer account_id, string basecampId, string vaultId, NewDocument document)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

vaultId

string

(Vault (folder))

Select a folder or enter a vault Id

True

document

NewDocument

(New document)

A new document

True

 

Returns:

          Type:Document

          Summary: Document

          Description: A document object

 

UploadFile

Summary: Upload file

Description: Upload a file

 

Syntax:

Basecamp3.UploadFile (integer account_id, string basecampId, string vaultId, string content_type, string name, string body)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

vaultId

string

(Vault (folder))

Select a folder or enter a vault Id

True

content_type

string

(Content type)

The content type of the file

True

name

string

(File name)

Name of the file being uploaded

True

body

string(binary)

 

 

True

 

Returns:

          Type:array of (Basecamp)

          Summary: Basecamps

          Description: A list of Basecamps

 

CreateScheduleEntry

Summary: Create a schedule entry

Description: Create a schedule entry

 

Syntax:

Basecamp3.CreateScheduleEntry (integer account_id, string basecampId, NewEntry scheduleEntry)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

scheduleEntry

NewEntry

(New schedule entry)

An entry to schedule

True

 

Returns:

          Type:Entry

          Summary: Schedule entry

          Description: An entry to schedule

 

Triggers:

Trigger OnMessagePosted

Summary: When a message is posted

Description: This operation triggers when a new message is posted in Basecamp.

 

Syntax:

Basecamp3.OnMessagePosted (integer account_id, string basecampId)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

 

Returns:

          Type:array of (Message)

 

Trigger OnToDoCreated

Summary: When a to-do is created

Description: This operation triggers when a new to-do is created in Basecamp.

 

Syntax:

Basecamp3.OnToDoCreated (integer account_id, string basecampId, string todolistId)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

todolistId

string

(To-do list)

Unique identifier of the to-do list.

True

ListToDoLists

 

Returns:

          Type:array of (ToDo)

 

Trigger OnToDoUpdated

Summary: When a to-do is updated

Description: This operation triggers when an existing to-do is updated in Basecamp.

 

Syntax:

Basecamp3.OnToDoUpdated (integer account_id, string basecampId, string todolistId)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

todolistId

string

(To-do list)

Unique identifier of the to-do list.

True

ListToDoLists

 

Returns:

          Type:array of (ToDo)

 

Trigger OnDocumentCreated

Summary: When a document is created

Description: This operation triggers when a new document is created in Basecamp.

 

Syntax:

Basecamp3.OnDocumentCreated (integer account_id, string basecampId, string vaultId)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

vaultId

string

(Vault (folder))

Select a folder or enter a vault Id

True

 

Returns:

          Type:array of (Document)

 

Trigger OnDocumentUpdated

Summary: When a document is updated

Description: This operation triggers when a document is updated in Basecamp.

 

Syntax:

Basecamp3.OnDocumentUpdated (integer account_id, string basecampId, string vaultId)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

vaultId

string

(Vault (folder))

Select a folder or enter a vault Id

True

 

Returns:

          Type:array of (Document)

 

Trigger OnDocumentDeleted

Summary: When a document is deleted

Description: This operation triggers when a document is deleted in Basecamp.

 

Syntax:

Basecamp3.OnDocumentDeleted (integer account_id, [Optional]string bucket)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

bucket

string

(Basecamp)

Basecamp to filter on

False

ListBasecamps

 

Returns:

          Type:array of (Document)

 

Trigger OnScheduledEntryDeleted

Summary: When a schedule entry is deleted

Description: This operation triggers when a schedule entry is deleted in Basecamp.

 

Syntax:

Basecamp3.OnScheduledEntryDeleted (integer account_id, [Optional]string bucket)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

bucket

string

(Basecamp)

Basecamp to filter on

False

ListBasecamps

 

Returns:

          Type:array of (Entry)

 

Trigger OnFileUploaded

Summary: When a file is uploaded

Description: This operation triggers when a file is uploaded in Basecamp.

 

Syntax:

Basecamp3.OnFileUploaded (integer account_id, string basecampId, string vaultId)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

vaultId

string

(Vault (folder))

Select a folder or enter a vault Id

True

 

Returns:

          Type:array of (Upload)

 

Trigger OnFileUpdated

Summary: When a file is updated

Description: This operation triggers when a file is updated in Basecamp.

 

Syntax:

Basecamp3.OnFileUpdated (integer account_id, string basecampId, string vaultId)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

vaultId

string

(Vault (folder))

Select a folder or enter a vault Id

True

 

Returns:

          Type:array of (Upload)

 

Trigger OnScheduledEntryCreated

Summary: When a schedule entry is created

Description: This operation triggers when a new schedule entry is created in Basecamp.

 

Syntax:

Basecamp3.OnScheduledEntryCreated (integer account_id, string basecampId)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

 

Returns:

          Type:array of (Entry)

 

Trigger OnScheduledEntryUpdated

Summary: When a schedule entry is updated

Description: This operation triggers when a schedule entry is updated in Basecamp.

 

Syntax:

Basecamp3.OnScheduledEntryUpdated (integer account_id, string basecampId)

 

Parameters:

Name

Type

Summary

Required

Related Action

account_id

integer

(Account Id)

Unique identifier of the account.

True

ListAccounts

basecampId

string

(Basecamp)

Unique identifier of the basecamp.

True

ListBasecamps

 

Returns:

          Type:array of (Entry)

 


 

Account

Summary:

Description: A Basecamp account

 

          Properties:

Name

Type

Summary

id

integer

Id

Unique identifier of the the Account

name

string

Name

The name of the the Account

product

string

Product

Identifies which Basecamp product the account is part of

href

string

URL

The URL of the Account


 

AccountList

Summary: Accounts

Description: A list of Accounts

 

          Properties:

Name

Type

Summary

accounts

array of (Account)

Accounts

All accounts you're a part of


 

Basecamp

Summary:

Description: A Basecamp

 

          Properties:

Name

Type

Summary

id

integer

Id

Unique identifier of the the Basecamp

status

string

Status

The status of the Basecamp

name

string

Name

The name of the the Basecamp

bookmark_url

string

Bookmark URL

The API URL at which to change bookmark status

app_url

string

Web URL

A link to the basecamp

bookmarked

boolean

Bookmarked

Whether or not this basecamp is bookmarked

dock

Dock

Dock

The tools available in this Basecamp

 

Dock

Summary: Dock

Description: The tools available in this Basecamp

 

          Properties:

Name

Type

Summary

chat

DockItem

Dock item

A tool in a Basecamp's dock

message_board

DockItem

Dock item

A tool in a Basecamp's dock

todoset

DockItem

Dock item

A tool in a Basecamp's dock

schedule

DockItem

Dock item

A tool in a Basecamp's dock

questionnaire

DockItem

Dock item

A tool in a Basecamp's dock

vault

DockItem

Dock item

A tool in a Basecamp's dock

 


 

BlobMetaData

Summary:

Description: Metadata for document Blobs

 

          Properties:

Name

Type

Summary

Id

string

Id

The unique identifier for the file or folder

Name

string

Name

The name of the file or folder

DisplayName

string

Name

The display name of the file or folder

Path

string

Path

The path of the file or folder

LastModified

string(date-time)

Name

The last modified date of the file or folder

Size

integer(int64)

Size

The size of the file or folder

MediaType

string

Media Type

The MIME media type of the file

IsFolder

boolean

Is Folder

Indicates whether the item is a folder

ETag

string

ETag

The ETag, a token used for syncing

FileLocator

string

File locator

The file locator (unknown use)


 

DockItem

Summary: Dock item

Description: A tool in a Basecamp's dock

 

          Properties:

Name

Type

Summary

id

integer

Id

Unique identifier of the the dock item

title

string

Title

The title of the the dock item

name

string

Name

The name of the the dock item

enabled

boolean

Enaled

Whether or not this item is available to use

position

number

Position

This item's order in the dock

app_url

string

Web URL

A link to the specific item in the Basecamp


 

Document

Summary: Document

Description: A document object

 

          Properties:

Name

Type

Summary

title

string

Title

The title of the document

content

string

Content

The content of the document, formatted as HTML

app_url

string

URL

A link to the document

id

integer

Id

The unique Id of the document

created_at

string(date-time)

Created date

The date the document was created

updated_at

string(date-time)

Updated date

The date the document was updated

vault_id

string

Vault Id

 

vault_title

string

Vault Title

 

vault_url

string

Vault Url

 


 

Entry

Summary: Schedule entry

Description: An entry to schedule

 

          Properties:

Name

Type

Summary

summary

string

Summary

A summarized description of the schedule entry

starts_at

string(date-time)

Start time

Time format: yyyy-MM-ddTHH:mm:ss.fffZ (2016-07-20T08:00:59.000Z)

ends_at

string(date-time)

End time

Time format: yyyy-MM-ddTHH:mm:ss.fffZ (2016-07-20T08:00:59.000Z)

app_url

string

URL

A link to the document

id

integer

Id

The unique Id of the document

created_at

string(date-time)

Created date

The date the entry was created

updated_at

string(date-time)

Updated date

The date the entry was updated


 

Message

Summary: Message

Description: A message posted to a basecamp

 

          Properties:

Name

Type

Summary

subject

string

Subject

The subject of the message

content

string

Content

The content of the message, formatted as HTML

url

string

URL

A link to the message

id

integer

Id

The unique Id of the message

created_at

string(date-time)

Created date

The date the message was posted

updated_at

string(date-time)

Updated date

The date the message was updated


 

NewDocument

Summary: New document

Description: A new document

 

          Properties:

Name

Type

Summary

title

string

Title

The title of the document

content

string

Content

The content of the document, formatted as HTML


 

NewEntry

Summary: New schedule entry

Description: An entry to schedule

 

          Properties:

Name

Type

Summary

summary

string

Summary

A summarized description of the schedule entry

starts_at

string(date-time)

Start time

Time format: yyyy-MM-ddTHH:mm:ss.fffZ (2016-07-20T08:00:59.000Z)

ends_at

string(date-time)

End time

Time format: yyyy-MM-ddTHH:mm:ss.fffZ (2016-07-20T08:00:59.000Z)

participant_ids

string

Participants

A comma separated list of participant email addresses


 

NewMessage

Summary: New message

Description: A message to post to a basecamp

 

          Properties:

Name

Type

Summary

subject

string

Subject

The subject of the message

content

string

Content

The content of the message, formatted as HTML


 

NewToDo

Summary: To-do

Description: A To-do in a To-do List

 

          Properties:

Name

Type

Summary

content

string

Content

What the to-do is for

description

string

Description

A description of the to-do, formatted as HTML

due_on

string(date-time)

Due on

A due date when the to-do should be completed

start_on

string(date-time)

Start on

A date when the to-do should be started


 

ToDo

Summary: To-do

Description: A To-do from a To-do List

 

          Properties:

Name

Type

Summary

id

integer

Id

Unique identifier of the the to-do

content

string

Content

What the to-do is for

description

string

Description

A description of the to-do, formatted as HTML

due_on

string(date-time)

Due on

A due date when the to-do should be completed

start_on

string(date-time)

Start on

A date when the to-do should be started


 

ToDoList

Summary: To-do list

Description: A To-do list

 

          Properties:

Name

Type

Summary

id

integer

Id

Unique identifier of the the to-do list

name

string

Name

The name of the the to-do list

description

string

Description

A description of the to-do list, formatted as HTML

completed

boolean

Completed

Whether or not all items in this to-do list are completed


 

Upload

Summary: Upload

Description: A file upload object

 

          Properties:

Name

Type

Summary

filename

string

File name

The file name of the upload

description

string

Description

The description of the uploaded file

app_url

string

URL

A link to the file

id

integer

Id

The unique Id of the file

created_at

string(date-time)

Created date

The date the file was uploaded

updated_at

string(date-time)

Updated date

The date the file was updated

content_type

string

Content type

The content type of the file

byte_size

integer

Size

The size in bytes of the uploaded file