Workvivo's chatbot framework is designed to transform how organisations interact and engage with their employees, enabling seamless, intuitive, and impactful conversations through an advanced, customisable chatbot platform.
This empowers organisations to create tailored chatbot experiences that go beyond simple text responses, enhancing in-chat interactions with multimedia and interactive elements.
Device(s): Web (Only)
Roles / Permissions: Admin, Developer
Availability: Limited Access
- Admin create Bot flow
- Published on developer.workvivo.com
- New Bot Conversation
- Leave Conversation
- Text only based template
Initial API Configuration:
Please refer to developer.workvivo.com for more details
- Use Workvivo APIs with a Bearer token
- Handle webhook requests from Workvivo.
- Verify the authenticity of webhook requests using a JWT provided by Workvivo.
Authorization for Workvivo APIs
To interact with Workvivo APIs, you need a Bearer token for authorization. Include the token in the Authorization header when making requests.
Scopes Required
The following scopes are required to use Workvivo APIs for chatbot interactions:
-
chats.bots.read – For reading chatbot information and configuration.
-
chats.bots.write – For creating chatbots and updating the configuration of a chatbot.
-
chats.message.write - For create messages in workvivo chat.
Handling Webhook Requests from Workvivo
When a user interacts with a chatbot in Workvivo, Workvivo sends a POST request to the webhook URL specified during bot creation. This request includes a JWT in the x-workvivo-jwt header for verifying the request’s authenticity.
Webhook Request Format
-
HTTP Method: POST
-
Content Type: application/json
Webhook Header
x-workvivo-jwt: JWT generated by Workvivo
Creating a Chatbot on Chat Admin
Navigate to Administration > Chat Admin > Manage Bots
Select "Add Chat Bot"
- Add in the Bot Nickname eg "Helpdesk"
- Add in Image URL of the Bot to give the bot an avatar in chat
- Select a Bot Type - This is a category the Bot resides in - Eg Productivity
- Add in the Bot Callback URL
Select the Audience
- This will determine who will have access to communicate with this Bot
- Global is set by default, Admins can multi select Teams
- Select "Save"
Once Saved
- The Bot is Disabled by default - Toggle it to Enable
From here you can Edit or Delete the Bot