Slack
To get started, first create a Slack app so the CalypsoAI bot can authenticate with Slack.
Get an API token and make the following request to your instance of the CalypsoAI app to get a Slack app manifest:
β
curl -H "Authorization: Bearer ${CALYPSOAI_TOKEN}" "${CALYPSOAI_URL}/backend/v1/bots/slack/manifest" > manifest.json
Slack apps are easily created and configured using a manifest. Go to <https://api.slack.com/apps/,>
click "Create New App" and select create from manifest. Paste the contents of the manifest.json
created above and click through the prompts until the application is created.
The credentials for an app can be found in the basic information of the app. You'll need the client ID, secret and signing secret. These are added to the application using the following variables:
β
CAI_MODERATOR_SLACK_CLIENT_ID="<client ID>" CAI_MODERATOR_SLACK_CLIENT_SECRET="<client secret>" CAI_MODERATOR_SLACK_SIGNING_SECRET="<signing secret>"
Once the CalypsoAI app has been restarted with the credentials, go back to the app in Slack and navigate to the "Install App" section. There will be a button to install the application to your workspace. Once installed, use the /configure
command in Slack and a popup will appear to enter a CalypsoAI API token, which will be used for requests sent to the app. Once a token is entered, you will be able to navigate to the chatbots section in the CalypsoAI web app and configure providers and scanners.
Microsoft Teams
TODO: Provision application in Azure
Once your application has been created, navigate to <https://dev.botframework.com/bots/new
> to register the app as a bot.
Enter the following values in the form:
Display name: CalypsoAI
Bot handle: cai-teams
Messaging endpoint:
${CAI_MODERATOR_BASE_URL}/backend/v1/bots/teams/messages
For pasting your app ID, this is the value labeled as Application (client) ID
in the overview of your app in Azure.
β
Once you register the bot, you can add the credentials to the CalypsoAI application:
β
CAI_MODERATOR_MS_TEAMS_APP_ID="" CAI_MODERATOR_MS_TEAMS_APP_PASSWORD="" CAI_MODERATOR_MS_TEAMS_BOT_ID="" CAI_MODERATOR_MS_TEAMS_TENANT_ID=""
The app ID and bot ID should be the same value. The app password can be created by clicking the value labeled by Client credentials
in your app's Azure overview (it should say something like 0 certificate, <X> secret
) and creating a new client secret. Copy the value to somewhere safe as it won't be accessible from this page again.
Once the CalypsoAI app has been restarted with the credentials, you can download the app through the web interface and add it to Microsoft Teams using the Upload an app
button under Apps
/ Manage your apps
. After installing to Teams, run the /configure
command to add an API token to the Teams app to authenticate with the CalypsoAI application.