README.md

lookup-slack-bot

This is the slack bot that responds to the /lookup commands in your Slack instance. You can try a publically available Lookup or when logged into your Twilio Console

Architecture

+----------------------+                   +---------------------------+
|                      |                   |                           |
|     Slack Bot/App    +-----------------> |     Twilio Function       |
|                      |                   |                           |
|   (runs in Slack]    |                   |        (function.js)      |
|                      | <---------------+ |                           |
+----------------------+                   +---------------------------+

Twilio Add-Ons Setup

1. Enable Add-ons in the Console
   • Make sure you filter the list by the Lookup Category
2. Take note of the unique name for each enabled add-on.
3. Update the list of add-ons at the top of the function.js file.

Twilio Function Setup

1. Setup a https://www.twilio.com/console/runtime/functions/manage with the code in function.js
2. Turn off signature validation inside your function
3. Enable ACCOUNT_SID and AUTH_TOKEN here: https://www.twilio.com/console/runtime/functions/configure

Slack Bot Setup

1. Browse to api.slack.com and login.
2. Create a new Slack App. Name the app and select your development Slack workspace.
3. Open the newly created app.
4. Browse to: Basic Information -> Add Features and Functionality
   1. Interactive Components -> Add the Twilio Function URL as the Request URL. Save Changes.
5. Browse to: Basic Information -> Slash Commands (e.g. /lookup).
6. Browse to Install App to install it in your workspace.
7. Create LOOKUP_SLACKBOT_TOKEN env variable here: https://www.twilio.com/console/runtime/functions/configure
8. Set LOOKUP_SLACKBOT_TOKEN to the Verification Token from your Slackbot's Settings -> Basic Information -> App Credentials -> Verfification Token
9. Browse down, Save Changes.

Using Lookup in Slack

1. Wait a few minutes. Perhaps restart Slack.
2. Simply type /lookup 12024561414
3. Select different enabled Lookup addons from the dropdown for additional information

Lookup in Slack