Campfire is an instant messaging tool used for communication and file sharing within teams.
Status: Preview |
Tier: Standard |
Version: 1.0 |
Name |
Summary |
List accounts |
|
List Rooms |
|
List Messages |
|
List Uploads |
|
CreateMessage (string account, string roomId, string message) |
Create a message |
Get user by ID |
Name |
Summary |
When a room is created |
|
When a new message is received |
|
When a file is uploaded |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
Summary: List accounts
Description: Retrieves the list of accounts this user has access too
Syntax:
Campfire.ListAccounts ([Optional]string parentOperation)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
parentOperation |
string
|
|
False |
Returns:
Type:AccountsResponse
Description: Account data for an account in Campfire
Summary: List Rooms
Description: Retrieves the list of rooms in an account
Syntax:
Campfire.ListRooms (string account)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
account |
string (Account) |
Account in Campfire |
True |
Returns:
Type:RoomsResponse
Description: Collection of Room Data
Summary: List Messages
Description: Retrieves messages in a room
Syntax:
Campfire.ListMessages (string account, string roomId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
account |
string (Account) |
Account in Campfire |
True |
|
roomId |
string (RoomId) |
A room associated with the account |
True |
Returns:
Type:MessagesResponse
Description: A collection of message data in Campfire
Summary: List Uploads
Description: Retrieves the uploads in a room
Syntax:
Campfire.ListUploads (string account, string roomId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
account |
string (Account) |
Account in Campfire |
True |
|
roomId |
string (RoomId) |
A room associated with the account |
True |
Returns:
Type:UploadResponse
Description: Data for uploaded files in Campfire
Summary: Create a message
Description: Sends a message to the given room.
Syntax:
Campfire.CreateMessage (string account, string roomId, string message)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
account |
string (Account) |
Account in Campfire |
True |
|
roomId |
string (RoomId) |
A room associated with the account |
True |
|
message |
string (Message text to be created) |
Message text to be created |
True |
Returns:
Description: A message
Summary: Get user by ID
Description: Retrieves information about a user by given ID
Syntax:
Campfire.GetUser (string account, integer userId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
account |
string (Account) |
Account in Campfire |
True |
|
userId |
integer(int32) (User ID) |
User ID |
True |
Returns:
Type:UserResponse
Summary: When a room is created
Description: Triggers when a new room is added to the authenticated user's account. Not applicable to Basecamp.
Syntax:
Campfire.OnNewRoom (string account)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
account |
string (Account) |
Account in Campfire |
True |
Returns:
Type:RoomsResponse
Description: Collection of Room Data
Summary: When a new message is received
Description: Triggers when a new message is received in a given room.
Syntax:
Campfire.OnNewMessage (string account, string roomId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
account |
string (Account) |
Account in Campfire |
True |
|
roomId |
string (RoomId) |
A room associated with the account |
True |
Returns:
Type:MessagesResponse
Description: A collection of message data in Campfire
Summary: When a file is uploaded
Description: Triggers when a file is uploaded to a given room. Not applicable to Basecamp.
Syntax:
Campfire.OnNewUpload (string account, string roomId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
account |
string (Account) |
Account in Campfire |
True |
|
roomId |
string (RoomId) |
A room associated with the account |
True |
Returns:
Type:UploadResponse
Description: Data for uploaded files in Campfire
Summary:
Description: Account data for an account in Campfire
Properties:
Name |
Type |
Summary |
accounts |
array of (AccountsItem) Accounts |
Collection Of Accounts |
Summary:
Description: Account in Campfire
Properties:
Name |
Type |
Summary |
id |
integer(int32) Account Id |
Id of the account |
name |
string Account Name |
Name of the account |
app_href |
string Account Link |
Link to the account |
account_url |
string Account url |
Account Url |
Summary:
Description: A message
Properties:
Name |
Type |
Summary |
message |
|
A Campfire message |
Summary:
Description: A Campfire message
Properties:
Name |
Type |
Summary |
body |
string Message Body |
Message Body. |
id |
integer(int32) Message Id |
Message Id. |
starred |
boolean Message Starred |
Boolean value, true if a message is starred. |
user_id |
integer(int32) User ID |
The unique ID of the user who created the message. |
Summary:
Description: A collection of message data in Campfire
Properties:
Name |
Type |
Summary |
messages |
array of (MessagesItem) Messages |
Collection Of messages |
Summary:
Description: A Campfire message
Properties:
Name |
Type |
Summary |
body |
string Message Body |
Message Body. |
id |
integer(int32) Message Id |
Message Id. |
starred |
boolean Message Starred |
Boolean value, True if a message is starred. |
user_id |
integer(int32) User ID |
The unique ID of the user who created the message. |
Summary:
Description: Collection of Room Data
Properties:
Name |
Type |
Summary |
rooms |
array of (RoomsItem) Rooms |
Collection of Rooms |
Summary:
Description: Data associated with a room
Properties:
Name |
Type |
Summary |
name |
string Room Name |
Room name. |
id |
string Room Id |
Room Id. |
locked |
boolean Room Locked |
Boolean value, True if a room is locked. |
topic |
string Room Topic |
Room topic or description. |
Summary:
Description: Data for uploaded files in Campfire
Properties:
Name |
Type |
Summary |
uploads |
array of (UploadsItem) Uploads |
Collection of Uploads |
Summary:
Description: Data for an uploaded file in Campfire
Properties:
Name |
Type |
Summary |
full_url |
string File Url |
File Url. |
room_id |
integer(int32) Room Id |
Room Id. |
id |
integer(int32) File Id |
File Id. |
content_type |
string Content Type |
Format of the uploaded file. |
name |
string File Name |
File name. |
created_at |
string(date-time) Created At |
Timestamp of upload. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
user |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
email_address |
string User Email |
|
name |
string User Name |
|
id |
integer(int32) User ID |
|