Bot Frameworks
Want to add a cool bot to your Ryver account that can watch for keywords in Forums and Teams and perform actions, or respond to direct requests? Ryver has provided support for building bots with either Hubot or BotKit. Currently, Hubot requires that you create a regular Ryver user and then authenticate using that user’s credentials. With BotKit, you can use Ryver’s new Custom Integration support to create a special integration “bot” user, and generate a key for authentication.
Build with Botkit
Botkit is one of the most popular bot-building developer tools. There is now a Ryver connector for integrating your Botkit bot with Ryver organizations.
Note: In order to build a BotKit bot that interacts with Ryver through Outbound Webhooks, you will need to request beta access to the new Custom Integration feature. Please contact support and we can enable custom integrations and outbound webhooks for your organization.
Read the BotKit Documentation
Check out the official Botkit Documentation to get started creating your own bots.
Learn about the Ryver Botkit connector
The Ryver Botkit NPM package readme explains how to configure your Botkit bot for use with Ryver.
Setting up a Ryver custom integration
In this section, we’ll explain how to configure a Custom Integration in Ryver to support your Botkit interface. You will create a new custom integration, and configure the “integration user” to be a bot. This will allow your bot user to be @mentioned in Ryver. We will also discuss setting up an outbound webhook to facilitate the two-way communication with your bot.
Create a Custom Integration
Currently, you’ll need to request beta access to our Custom Integrations and Outbound Webhook features. Once that is enabled for your organization, you can create a new Custom Integration for your bot from the Integrations menu item in the top nav bar menu. Note: You need to be an Admin in your organization to access this menu item.
Add an Outbound Webhook to your integration
Once you have created a new Custom Integration, add an Outbound Webhook, and select the events you want to have sent to your bot. You should at least enable the “Chat message created” event.
Generate an authentication token
For creating new content in Ryver using the Ryver Rest APIs, you will need to authenticate your requests. Rather than use Basic Authentication for your bot user, you will be using token authentication. On the Tokens tab in your Custom Integration, generate a new token and copy the token value for use in your bot implementation. All of your Rest API requests will need to include a Bearer authentication header like this:
Authorization: Bearer uat-47845bexample2880728815f49768
Build with Hubot
We built a Hubot adapter for Ryver that allows you to add your own bots to your Ryver organization.
You’ll need to create a Ryver user to map your bot to, and add that user to any teams you want it to respond in.
Read the Hubot documentation
Check out the official Hubot Documentation to get started creating your own bots.
Configure the Ryver Hubot adapter
Here is a link to the Ryver Hubot adapter on Github: Ryver Hubot Adapter
Configuration information is provided in the readme file.