Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

HipChat is a web service for internal private online chat and instant messaging.

This document provides information about the HipChat connector, which facilitates automated interactions with HipChat using FortiSOAR™ playbooks. Add the HipChat connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving a list of all users or rooms from HipChat and sending a message to a room in HipChat.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

 

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-hipchat

For the detailed procedure to install a connector, click here.

 

Configuring the connector

For the procedure to configure a connector, click here.

 

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:

 

Function Description Annotation and Category
Get All Users Retrieves a list of all users from HipChat. get_user
Investigation
Get All Rooms Retrieves a list of all rooms from HipChat. get_rooms
Investigation
Send Message Sends a message to a room in HipChat. send_message
Investigation

 

Included playbooks

The Sample - HipChat - 1.0.0 playbook collection comes bundled with the HipChat connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the HipChat connector.

 

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection, since the sample playbook collection gets deleted during connector upgrade and delete.

 

About the connector

HipChat is a web service for internal private online chat and instant messaging.

This document provides information about the HipChat connector, which facilitates automated interactions with HipChat using FortiSOAR™ playbooks. Add the HipChat connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving a list of all users or rooms from HipChat and sending a message to a room in HipChat.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

 

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-hipchat

For the detailed procedure to install a connector, click here.

 

Configuring the connector

For the procedure to configure a connector, click here.

 

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:

 

Function Description Annotation and Category
Get All Users Retrieves a list of all users from HipChat. get_user
Investigation
Get All Rooms Retrieves a list of all rooms from HipChat. get_rooms
Investigation
Send Message Sends a message to a room in HipChat. send_message
Investigation

 

Included playbooks

The Sample - HipChat - 1.0.0 playbook collection comes bundled with the HipChat connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the HipChat connector.

 

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection, since the sample playbook collection gets deleted during connector upgrade and delete.