HipChat is group chat, video chat and screen sharing tool for teams of all sizes. Built for business, HipChat is persistent, searchable and loaded with goodies your team will love.
Status: Preview |
Tier: Standard |
Version: 1.0.0 |
Name |
Summary |
List users in a room |
|
Get user by Id |
|
Post message to a room |
|
List Rooms |
|
Add a user to a room |
Name |
Summary |
When a message is posted to a room |
|
When a file is uploaded to a room |
|
When a new room is added |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
Summary: List users in a room
Description: Gets all members of an existing room.
Syntax:
HipChat.ListUsers (string roomId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roomId |
string (Room ID) |
Room |
True |
Returns:
Type:UserList
Summary: Get user by Id
Description: Get a user's details by user id.
Syntax:
HipChat.GetUserByID (string userid)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
userid |
string (User Id) |
The id of the user |
True |
Returns:
Type:UserResponse
Summary: Post message to a room
Description: Post new message to an existing room.
Syntax:
HipChat.PostMessage (string roomId, PostMessageParameterBody body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roomId |
string (Room ID) |
Room |
True |
|
body |
|
|
True |
Returns:
Type:NewMessage
Summary: List Rooms
Description: List the rooms the user has access to.
Syntax:
HipChat.ListRooms ()
Returns:
Type:RoomList
Summary: Add a user to a room
Description: Adds a member to a private room.
Syntax:
HipChat.AddUserToRoom (string roomId, string memberid)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roomId |
string (Room ID) |
Room |
True |
|
memberid |
string (User Id or Email) |
The id, email or mention name of the user. |
True |
Returns:
Type:string
Summary: When a message is posted to a room
Description: Triggers when a new message is posted to an existing room.
Syntax:
HipChat.OnNewMessage (string roomId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roomId |
string (Room ID) |
Room |
True |
Returns:
Type:HistoryResponse
Summary: When a file is uploaded to a room
Description: Triggers when a file is uploaded an existing room.
Syntax:
HipChat.OnNewFile (string roomId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
roomId |
string (Room ID) |
Room |
True |
Returns:
Type:HistoryResponse
Summary: When a new room is added
Description: Triggers when a room is created.
Syntax:
HipChat.OnNewRoom ()
Returns:
Type:RoomList
Summary:
Description:
Properties:
Name |
Type |
Summary |
items |
array of (ItemsItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
date |
string(date-time) Date Posted |
Date the message was sent in ISO-8601 format. |
file |
|
|
from |
Author's info. |
The user that sent the message. |
id |
string Message Id |
Unique id of the message. |
message |
string Message |
Body of the message. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string File Name |
Name of the file. |
url |
string File URL |
URL of the file. |
Summary: Author's info.
Description: The user that sent the message.
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string Message Id |
Unique id of the message. |
timestamp |
string Date Posted |
Date the message was sent in ISO-8601 format. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
message |
string Message |
Text of the message. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
items |
array of (ItemsItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Room Id |
Id of the room. |
is_archived |
boolean Archived |
True if the room is archived. |
name |
string Room Name |
Name of the room. |
privacy |
string Private |
True if the room is private. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
items |
array of (ItemsItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) User Id |
Member's user id. |
is_present_in_room |
boolean User Is Present |
User Is Present. |
mention_name |
string Mention Name |
Member's mention name. |
name |
string User Name |
Member's display user name. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
|
string |
User's email. |
id |
integer(int32) User Id |
User's id. |
mention_name |
string Mention Name |
User's @mention name. |
name |
string Name |
User's full name. |