Kore.ai provides integration for a built-in Beanstalk Bot that you can use to display message notifications and execute tasks directly from your messaging channel such as Kore.ai Messenger. To use the Beanstalk Bot, you just need to add the Bot to your channel and then configure the settings for the Bot, such as authentication to access Beanstalk and the notification messages that you want. For more information about other Kore.ai Bots, see Adding Bots
About the Kore.ai Bot for Beanstalk
Beanstalk is a Platform as a Service (PaaS) service from Amazon Web Services that allows users to create applications and push them to a definable set of AWS services. You can use this Bot to get updates, create comments, and request code reviews in your messaging channel.
|Integration Type||Webhook – Connect to this Bot using a webhook integration where the web application pushes message notifications in near real time.
Web Service – Connect to this Bot using a web service integration where Kore.ai polls the service for updates based on a specified interval.
|Category||Developer Tools – This Bot is available in the Kore.ai Bot Store in the Developer Tools category.|
|Channels||Kore.ai – This Bot is available in the Kore.ai Messenger application.
Spark – This Bot is available in the Cisco Spark application.
Slack – This Bot is available in the Slack application.
Skype – This Bot is available in the Skype application.
To configure a Beanstalk webhook for Kore.ai, you must have a Beanstalk account with administrator access as well as API access to configure a webhook. If you don’t, you’ll need to contact the Beanstalk system administrator for your company. For more information, see the Beanstalk Help in the Beanstalk documentation.
To get started configuring the webhook in Beanstalk, you’ll need two things:
- The Kore.ai webhook URL provided when you set up an alert in your messaging channel for each alert that you want to enable in Beanstalk.
- A valid Username and Password for an account with Beanstalk API access.
The webhook URL is account-specific and cannot be transferred to any other account. This means that if you configure a Beanstalk webhook using a test account, you will have to recreate the alert and get a new webhook URL to configure in Beanstalk. The following URL is an example webhook URL.
Configuring Webhook Tasks
This procedure describes the steps in Beanstalk to configure a webhook using a Kore.ai webhook URL endpoint.
- Log on to Beanstalk, and then on the Repository tab, select a repository to create a webhook for.
- On the Settings tab, click Integration.
- In the list of integrations, select Modular Webhooks, and then click Add a webhook. The Add a webhook dialog is displayed.
- In the Name field, enter a name for the webhook configuration used in the Beanstalk user interface.
- In the URL field, enter the Kore.ai webhook URL for the alert.
- In the Select webhook triggers section, select one or more events that you want to get Kore.ai alert messages for.
- Click Activate to save the webhook configuration and close the Add a webhook dialog.
For more information, see Classic Webhooks Integration in the Beanstalk documentation.
To setup real-time notifications in your messaging channel using a Beanstalk webhook, for example, in the Kore.ai Messenger channel, click the New Task icon, click Get notified when…, click Information Updates, and then in the Setup Task dialog:
- click the Activate button to generate a Webhook URL.
- copy and save the URL, or click Email Instructions to send the URL to an email account. For more information, see Configuring Beanstalk Webhooks.
- optionally, click the gray box in Filters to setup one or more filters to prevent message notifications for specified criteria. You can filter on one or more of the following:
- Click Done to save the filter. For more information, see Setting up Filters.
- optionally customize the Task Name
- optionally customize the Short Description
- enable or disable Mute task notifications
- and then click Finish.
Configuring Web Service Tasks
To configure web service tasks, you need to add the Beanstalk Bot from the Kore.ai Bot Store in your messaging channel, and then setup the task. After you add a web service task and are connected, you can perform tasks for Beanstalk and setup message notifications to get notified in your messaging channel when an event occurs in Beanstalk.
To setup an Beanstalk task in the Kore.ai Messenger channel, click the New Task icon, and then click one of the Beanstalk web services described in the following table.
|TASK||TO CONFIGURE THIS TASK…|
|Add Comment||In the Perform Task dialog,
In a team room, you can enter the @beanstalk add_a_comment Bot command to invoke and configure this task.
|Request code review||In the Perform Task dialog,
In a team room, you can enter the @beanstalk request_code_review Bot command to invoke and configure this task.
After the webhook is configured in Beanstalk, when any of the events occur in Beanstalk, a message is displayed on the Bots page in Kore.ai Messenger or your messaging channel.