The Workplace Chat channel offers more or less the same features and limitations as the Messenger channel, as they are built on top of the same platform. However, there are some key differences, in how they are installed, configured and what specific features and limitations they offer.
CSML is available as a free third-party app for Workplace.
To uninstall a Workplace Chat channel, you need to delete the channel both on Workplace, and on CSML Studio. Only removing the channel on CSML Studio will leave the chatbot visible to Workplace users.
To remove the bot from Workplace, visit the Workplace admin panel (under Integrations) and find your bot in the list of available bots.
Click on Uninstall then confirm. Your bot will immediately be removed from Workplace chat, however users that already talked to the bot will still be able to find their conversation history.
After this is done, you can safely remove the channel from CSML Studio as well.
Workplace Chat is very, very similar to Messenger (except that it's grey). Please refer to Messenger's CSML documentation:
Broadcasts can be sent without any limitation to any of your Workplace Chat users, with either their valid Workplace email address or ID as the user_id.
A sample _metadata
for an incoming event will be similar to the following object:
How to setup a Workplace Chat channel in CSML Studio
Installing a Workchat bot on CSML Studio is very easy, as it only takes one click. However, it does require admin rights on your Workplace instance.
Go to Channels > Connect a new Channel > Workplace Chat.
If you are a Workplace admin, simply click on the button and follow the instructions. Otherwise, copy the URL just below and send it to a Workplace admin. They will be able to complete the installation flow autonomously, even if they do not have a CSML Studio account. After clicking on the button or link, you will be redirected to the app setup page on Workplace.
From there, you can configure its name, description and logo by clicking on Customize.
You can also set which groups will have access to the bot.
If you want everyone to have access to this chatbot, leave the All groups box checked.
If you want to restrict access to the members of specific groups, check Specific groups instead, then select which groups are allowed to access the bot. Users that are not in one of the selected groups will not be able to search for or chat with the bot in Workchat.
Click on Add to Workplace and you are done!
You can find similar configuration settings between and Workchat channels. However, Workchat being a professional, internal-only communication channel, there are some additional options you can play with.
The Broadcast feature allows you to trigger any flow for any given user or list of users. To use the broadcast feature, click on Send broadcast to open a configuration popup.
Under Flow, select the flow you want to trigger
Under Targets, list the emails (one per line) you want to receive the broadcast
Under Context, you can optionally add any additional context that you want to set in the _metadata
object for this broadcast
Once you hit Send, the broadcast will be sent immediately.
For a very large number of targets, consider splitting into smaller sets.
If the broadcast were to fail sending for any reason, you would not want to retry all the users again, as some may receive the broadcast twice!