LingoBot Cisco Spark Setup

This portion of the installation guide only applies if the collaboration environment you will be using is Cisco Spark. If you will be using either Slack or CA Flowdock, please follow the corresponding setup instructions.

Configuring LingoBot to communicate via Cisco Spark is a fairly straight forward process. All that is required is access to an account that has access to your organization's Cisco Spark.

Creating a Custom Bot

• The first step is to sign in to your Cisco Spark account on the Developer Portal.
• Once signed in, navigate to the Custom Bot Creation page.
• On the bot creation page, fill in the form with the following information:
  • Display Name: By default, we recommend simply calling it "lingobot", however you're welcome to name it whatever you would like.
    • If you do choose to call it something other than "lingobot", make sure that you set the LINGOBOT_NAME variable in the configuration file to whatever name you chose.
    • Example: export LINGOBOT_NAME=lingobot-123
  • Bot Name: Ideally this should be the same as the display name, however due to the necessity that it be unique this can be just about anything. This will only be used to invite the bot to a chat room.
  • Icon: Paste the following URL into the Icon field: http://i.imgur.com/3bzw0zp.jpg
• Once this is done, click "Add Bot". On the following page, you will find an API token. Click the "Copy" button next to it (or select and copy the token itself) then paste it into the LingoBot configuration file next to the CISCOSPARK_ACCESS_TOKEN variable declaration.

Example:

export CISCOSPARK_ACCESS_TOKEN=LDA5YjBiOTItMTAwOS00ODMxLTk4ZjEtYTQ4OGI4N2FjN2Y2MjVlM2QyNTUtYmM2

Creating a Webhook for LingoBot

• The final step is to create a webhook that LingoBot can receive message event notifications through. To do this, navigate to the Spark Webhook Creation Page.
• Make sure that the "Test Mode" switch is turned ON. This will allow you to generate webhooks directly into your organization's account.
• Under the "Request Headers" section, fill in the following information:
  • Authorization: "Bearer [YOUR BOT'S API TOKEN HERE]"
• In the "Request Parameters" section, fill in the the following information under the "Your values" column:
  • name: This can be anything. i.e. "lingobot".
  • targetURL: "[YOUR JENKINS INSTANCE URL HERE]:5001/hubot/ciscospark/incoming"
  • resource: "all"
  • event: "all"
  • secret: This can be just about anything, but ideally it is a random string of letters and numbers that it at least 32 characters long.
    • Whatever you chose for this must also be copied to the LingoBot configuration file, next to the CISCOSPARK_SECRET variable declaration.

Example:

export CISCOSPARK_SECRET=a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6

• Once all of these values have been entered, click the "Run" button. You should see a response containing the webhook's information on the right.

Finally, make sure the LINGOBOT_ADAPTER variable is set to "sparkwebhook".

Example:

export LINGOBOT_ADAPTER=sparkwebhook

Once this is complete, the bot is now configured and ready to be installed! Follow the instructions below on running the installation script to finish the installation process.

Next Step: Install and Start the Lingobot Service