Publisher: Phantom
Connector Version: 1.0.5
Product Vendor: Atlassian
Product Name: HipChat
Product Version Supported (regex): ".*"
Minimum Product Version: 4.0.1068
This app integrates with HipChat to support different generic and investigative actions
You need to generate the API token from your HipChat account with scopes Send Message and View Group.
The below configuration variables are required for this Connector to operate. These variables are specified when configuring a HipChat asset in SOAR.
VARIABLE | REQUIRED | TYPE | DESCRIPTION |
---|---|---|---|
server_url | required | string | Server URL (e.g. https://10.10.10.10) |
verify_server_cert | optional | boolean | Verify Server Certificate |
api_token | required | password | API token |
test connectivity - Validate the asset configuration for connectivity using supplied configuration
list rooms - List non-archived rooms
list users - List all active users
upload file - Upload file to HipChat
send message - Send message to HipChat user
Validate the asset configuration for connectivity using supplied configuration
Type: test
Read only: True
No parameters are required for this action
No Output
List non-archived rooms
Type: investigate
Read only: True
No parameters are required for this action
DATA PATH | TYPE | CONTAINS |
---|---|---|
action_result.status | string | |
action_result.data.*.id | numeric | hipchat room id |
action_result.data.*.is_archived | boolean | |
action_result.data.*.links.members | string | url |
action_result.data.*.links.participants | string | url |
action_result.data.*.links.self | string | url |
action_result.data.*.links.webhooks | string | url |
action_result.data.*.name | string | hipchat room name |
action_result.data.*.privacy | string | |
action_result.data.*.version | string | |
action_result.summary.total_rooms | numeric | |
action_result.message | string | |
summary.total_objects | numeric | |
summary.total_objects_successful | numeric |
List all active users
Type: investigate
Read only: True
No parameters are required for this action
DATA PATH | TYPE | CONTAINS |
---|---|---|
action_result.status | string | |
action_result.data.*.id | numeric | hipchat user id |
action_result.data.*.links.self | string | url |
action_result.data.*.mention_name | string | user name |
action_result.data.*.name | string | |
action_result.data.*.version | string | |
action_result.summary.total_users | numeric | |
action_result.message | string | |
summary.total_objects | numeric | |
summary.total_objects_successful | numeric |
Upload file to HipChat
Type: generic
Read only: True
If parameter destination_type is User, parameter destination can be ID/mention name/email of a user.
If parameter destination_type is Room, parameter destination can be ID/name of a room.
PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS |
---|---|---|---|---|
destination_type | required | Type of destination | string | |
destination | required | Room or User to upload to | string | email user name hipchat user id hipchat room name hipchat room id |
vault_id | required | Vault ID of file to send | string | vault id sha1 |
message | optional | Message to send with file | string |
DATA PATH | TYPE | CONTAINS |
---|---|---|
action_result.status | string | |
action_result.parameter.destination | string | email user name hipchat room id hipchat room name hipchat user id |
action_result.parameter.destination_type | string | |
action_result.parameter.message | string | |
action_result.parameter.vault_id | string | sha1 vault id |
action_result.message | string | |
summary.total_objects | numeric | |
summary.total_objects_successful | numeric |
Send message to HipChat user
Type: generic
Read only: True
If parameter destination_type is User, parameter destination can be ID/mention name/email of a user.
If parameter destination_type is Room, parameter destination can be ID/name of a room.
PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS |
---|---|---|---|---|
destination_type | required | Type of destination | string | |
destination | required | Room or User to send message to | string | email user name hipchat room id hipchat user id hipchat room name |
message | required | Message to send | string |
DATA PATH | TYPE | CONTAINS |
---|---|---|
action_result.status | string | |
action_result.parameter.destination | string | email user name hipchat user id hipchat room name hipchat room id |
action_result.parameter.destination_type | string | |
action_result.parameter.message | string | |
action_result.data.*.id | string | |
action_result.data.*.timestamp | string | |
action_result.message | string | |
summary.total_objects | numeric | |
summary.total_objects_successful | numeric |