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.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Flow Standard All Flow regions except the following:
     -   US Government (GCC)
PowerApps Standard All PowerApps regions except the following:
     -   US Government (GCC)

Creating a connection

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

Name Type Description
Peronal Access Token https://aka.ms/v6fdie securestring

Generate a personal access token with all scopes selected and paste it here.

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds
Frequency of trigger polls160 seconds

Actions

Add a user to a room

Adds a member to a private room.

Get user by Id

Get a user's details by user id.

List users in a room

Gets all members of an existing room.

Post message to a room

Post new message to an existing room.

Add a user to a room

Adds a member to a private room.

Parameters

Name Key Required Type Description
Room ID
roomId True string

Room

User Id or Email
memberid True string

The id, email or mention name of the user.

Get user by Id

Get a user's details by user id.

Parameters

Name Key Required Type Description
User Id
userid True string

The id of the user

Returns

List users in a room

Gets all members of an existing room.

Parameters

Name Key Required Type Description
Room ID
roomId True string

Room

Returns

Body
UserList

Post message to a room

Post new message to an existing room.

Parameters

Name Key Required Type Description
Room ID
roomId True string

Room

Message
message True 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.

When a message is posted to a room

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

When a new room is added

Triggers when a room is created.

When a file is uploaded to a room

Triggers when a file is uploaded an existing room.

Parameters

Name Key Required Type Description
Room ID
roomId True string

Room

Returns

When a message is posted to a room

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

Parameters

Name Key Required Type Description
Room ID
roomId True string

Room

Returns

When a new room is added

Triggers when a room is created.

Returns

Body
RoomList

Definitions

HistoryResponse

Name Path Type Description
items
items array of object
Date Posted
items.date date-time

Date the message was sent in ISO-8601 format.

File Name
items.file.name string

Name of the file.

File URL
items.file.url string

URL of the file.

Author's info.
items.from

The user that sent the message.

Message Id
items.id string

Unique id of the message.

Message
items.message string

Body of the message.

UserList

Name Path Type Description
items
items array of object
User Id
items.id integer

Member's user id.

Mention Name
items.mention_name string

Member's mention name.

User Name
items.name string

Member's display user name.

NewMessage

Name Path Type Description
Message Id
id string

Unique id of the message.

Date Posted
timestamp string

Date the message was sent in ISO-8601 format.

RoomList

Name Path Type Description
items
items array of object
Room Id
items.id integer

Id of the room.

Archived
items.is_archived boolean

True if the room is archived.

Room Name
items.name string

Name of the room.

Private
items.privacy string

True if the room is private.

UserResponse

Name Path Type Description
Email
email string

User's email.

User Id
id integer

User's id.

Mention Name
mention_name string

User's @mention name.

Name
name string

User's full name.