hubot-cm-webhook v1.0.3

Description

This is the COMPANY Messenger adapter for hubot.

Installation

1. Install the hubot generator

You will need node.js and npm. Once those are installed, we can install the hubot generator.

    $ npm install -g yo generator-hubot

This will give us the hubot yeoman generator.

2. Install the hubot

Now you can make a new directory, and generate a new instance of hubot in it, using this COMPANY Messenger adapter.

    $ mkdir myhubot
    $ cd myhubot
    $ yo hubot --adapter cm-webhook

You will be asked a few questions about the bot you are creating. When you finish answering, yeoman will download and install the necessary dependencies.

3. Configure environment variables

COMPANY Messenger adapeter uses the following environment variables.

• PORT The port number which hubot runs. Please change as needed. It default is 8080.
• HUBOT_CM_HOSTNAME The host name you want to connect to.
• HUBOT_CM_API_KEY Bot user's API key.
• HUBOT_CM_SECRET_KEY Bot user's secret key.
• HUBOT_CM_WEBHOOK_TOKEN The token that guarantees that it is a message from COMPANY Messenger. Please check on the admin console outgoing webhook page.

You will need to configure these environment variables in your hubot's bin/hubot.

    export PORT="8080"
    export HUBOT_CM_HOSTNAME="xxx.lakeel.com"
    export HUBOT_CM_API_KEY="api_key"
    export HUBOT_CM_SECRET_KEY="secret_key"
    export HUBOT_CM_WEBHOOK_TOKEN="webhook_token"

4. Outgoing Webhook URL

On the admin console outgoing webhook page, please set the following URL as Webhook URL (Destination settings).

    http://[YOUR_HOSTNAME]:[PORT]/webhook

• YOUR_HOSTNAME The host name or IP address of the host on which the hubot is deployed.
• PORT The port number set above.

5. Run the hubot

Finally, you can run hubot with COMPANY Messenger adapter.

    bin/hubot -a cm-webhook

Copyright

Copyright © 2017 LaKeel, Inc. See LICENSE for details.