HipChat (Preview)

HipChat (Preview)

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.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds
Frequency of trigger polls 1 60 seconds

Creating a connection

To connect your account, you will need the following information:

Peronal Access Token https://aka.ms/v6fdie
securestring
Generate a personal access token with all scopes selected and paste it here.

Actions

Add a user to a room

Adds a member to a private room.

Required Parameters

Room ID
string
Room
User Id or Email
string
The id, email or mention name of the user.

Get user by Id

Get a user's details by user id.

Required Parameters

User Id
string
The id of the user

Returns

List users in a room

Gets all members of an existing room.

Required Parameters

Room ID
string
Room

Returns

Body
UserList

Post message to a room

Post new message to an existing room.

Required Parameters

Room ID
string
Room
Message
string
Text of the message.

Returns

Body
NewMessage

Triggers

When a file is uploaded to a room

Triggers when a file is uploaded an existing room.

Required Parameters

Room ID
string
Room

Returns

When a message is posted to a room

Triggers when a new message is posted to an existing room.

Required Parameters

Room ID
string
Room

Returns

When a new room is added

Triggers when a room is created.

Required Parameters

Room ID
string
Room

Returns

Body
RoomList

Definitions

HistoryResponse

Date Posted
date-time
Date the message was sent in ISO-8601 format.
File Name
string
Name of the file.
File URL
string
URL of the file.
Mention Name
string
Author's mention name.
Message
string
Body of the message.
Message Id
string
Unique id of the message.
User Id
integer
Author's user id.
User Name
string
Author's display user name.
items
array of object

UserList

Mention Name
string
Member's mention name.
User Id
integer
Member's user id.
User Name
string
Member's display user name.
items
array of object

NewMessage

Date Posted
string
Date the message was sent in ISO-8601 format.
Message Id
string
Unique id of the message.

RoomList

Archived
boolean
True if the room is archived.
Private
string
True if the room is private.
Room Id
integer
Id of the room.
Room Name
string
Name of the room.
items
array of object

UserResponse

Email
string
User's email.
Mention Name
string
User's @mention name.
Name
string
User's full name.
User Id
integer
User's id.