Adapter - BluIP-BeHive
This page describes version 2.0.6 of the adapter.
Overview
This adapter interacts with BluIP's BeHive REST Api to send chat messages to individual users or workspaces.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| clientId | Integration Client Identifier | True | The clientId required for integration access. | string | 1024 | ||||
| clientSecret | Integration Client Secret | True | The client secret key required for integration access. | password | 1024 |
Commands
Get Available Contacts (getAvailableContacts)
returns a list of available contacts
Response Properties
| Name | Description | Type |
|---|---|---|
| data | The array of available contacts. | array |
| data.userId | The UserID (GUID) for the user. | string |
| data.username | The user's user name. | string |
| data.firstname | The user's first name. | string |
| data.lastname | The user's last name. | string |
Get Available Workspaces (getAvailableWorkspaces)
returns a list of available workspaces
Response Properties
| Name | Description | Type |
|---|---|---|
| data | The array of available workspaces. | array |
| data.workspaceId | The workspace identifier for the workspace. | string |
| data.name | The name of the workspace. | string |
| data.initials | The initials for the workspace. | string |
| data.memberscount | The number of members in the workspace. | string |
| data.chatId | The chat identifier for the workspace. | string |
| data.isFavorite | True, if the workspace is set as favorite. | string |
| data.isMuted | True, if the workspace is set to muted. | string |
| data.isEmergency | True, if the workspace is set as an emergency type workspace. | string |
| data.isEmergencyExtension | True, if the workspace has an emergency extension. | string |
| data.branchId | The branch identifier for the workspace. | string |
Get Private Chat ID (getPrivateChatId)
returns private Chat ID for a user
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| userId | User ID | The User ID (GUID) to lookup. (i.e. 17bdb7b3-4ba5-4165-8624-08d6ba4593cd) | True | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| chatId | The chat identifier for the user. | string |
Send Chat Message (sendChatMessage)
Sends a chat message to a user workspace using the Chat ID.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| chatId | Chat ID | The Chat ID of the user or workspace to send a message to. | True | string |
| chatMessage | Chat Message | The content of the message. | True | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | ||
| 2.0.5 | Maintenance | Updated third-party components and improved maintainability. | NAP-11518 | |
| 2.0.6 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-11-29 |