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 - US Department of Defense (DoD) |
| Power Automate | Standard | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Standard | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Microsoft |
| URL | Microsoft LogicApps Support Microsoft Power Automate Support Microsoft Power Apps Support |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft |
| Website | https://www.atlassian.com/software/hipchat/downloads |
| Privacy policy | https://www.atlassian.com/legal/privacy-policy |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Peronal Access Token https://aka.ms/v6fdie | securestring | Generate a personal access token with all scopes selected and paste it here. | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
| Frequency of trigger polls | 1 | 60 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. |
Returns
- response
- string
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
- Body
- UserResponse
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
- Body
- HistoryResponse
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
- Body
- HistoryResponse
When a new room is added
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
|
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. |
string
This is the basic data type 'string'.