Connecting to Collaboration Tools
Connect Revolution to the Slack and Microsoft Teams collaboration tools to:
- Post to the tool and allow users to activate notifications from the tool using a Revolution application.
- Post to the tool through a webhook you created within the tool.
DISCLAIMERS:
- You should regularly test your connections to these third-party applications.
- The tokens and webhooks you create may expire at any time, requiring reauthorization.
- Intrado takes no responsibility for the content you generate, and we expect you to fully comply with the third-party content guidelines.
- You agree to use the third-party tools as intended with no extensive posting.
Using this flow, you will be able to send notifications to specific Slack channels as well as activate notifications from within Slack.
Note: Creating this Token also installs the Mitel Revolution application to the Slack workspace.
This token is specific to your login credentials for Slack. You will be connecting directly to Slack, so be sure to have your login and password credentials before beginning this process.
- Go to Configuration > Integrations > Token
- Select New
- For Name, enter a name for this token to make it easily identifiable. You will be referring to this token in several places.
-
For Available in All Sites:
- Enable to ensure all your site locations have access.
- Disable and select a Site to limit which site has access.
- For Token Type, select Slack
- Select Authorize, which opens a browser pop-up and connects you to the Slack authorization screen.
- During authorization, you will be asked for your Slack workspace URL and login information (email address and password). Follow the Slack authentication procedures.
- Select Save
Other steps in this process will reference this Token.
Create an endpoint for a specific channel, which will receive a notification.
- Go to Configuration > Integrations > Collaboration > Slack
- Select New > New Slack Service
- For Name, enter a name for the service to make it easily identifiable. You will use this when creating notifications that post to Slack.
- For Posting Method, select App.
- For Token, select the token for the account you want to send from. Alternatively, you can select CREATE NEW to create one at this point. See Creating a Token and installing the application.
For Channel, select one of the Slack channels from the list of available channels to receive a notification.
You must invite the Mitel Revolution app to the channel before it can receive notifications. See Setting up Slack to work with the Revolution app
- (optional) For Link, specify a URL to include at the end of any communication.
- Select Save
After creation, you can edit or delete the media service from the Webhook page under the Slack Service heading.
Create this trigger to enable the activation of a notification using the Revolution Slack application. You will also have the option to limit which channels and users have access to the application.
- Go to Configuration > Integrations > Collaboration > Slack
- Select New > New Slack Trigger
- For Name, enter a name for the service to make it easily identifiable. You will use this when completing the Select Triggers section when creating your notification
For Available in All Sites:
- Enable to ensure all your site locations have access.
- Disable and select a Site to limit which site has access.
- For Token, select the appropriate token. Alternatively, you can select CREATE NEW to create one at this point. See Creating a Token and installing the application.
For Channels, define the channels from which you can activate notifications. Select any number of channels from the list of available channels.
If you do not identify any channels, you can activate notifications from any channel.
For Users, define the users who can activate notifications. Select any number of users from list of available users.
If you do not identify any users, all users can activate notifications.
- Select Save.
Perform the following actions in Slack to ensure that the Revolution app can interact with your channels.
You can only perform these actions after Creating a Token and installing the application.
- Go to a channel that you will be posting to or from.
-
Invite the application to the channel (Slack will auto complete your entry):
/invite @revolution -
Test the /revolution command by entering:
/revolution help
Add your Slack service as an endpoint to any existing or newly created notification.
You should not set your Slack Services as an endpoint on notifications that fire frequently.
- Go to Notifications > Manage.
- Select New Notification.
- Complete the General and Select Triggers sections as needed.
- For Message Details, remember that Slack may use information from: Select Image, Title, and Body.
- For Endpoint & Contact Selection, in the Endpoints tab, search for and select the Slack service you created with Designating Slack as an endpoint to receive notifications.
This notification triggers off the Slack trigger you created in Creating a Slack trigger, which is used by the activate command in the Revolution Slack application.
- Go to Notifications > Manage.
- Select New Notification.
- Complete the General section as needed.
- In Select Triggers:
- For Activator, select Webhook
- For Trigger, select the trigger you created previously.
- In Message Details, complete Title and Body, using static text or variables, which will use information from the Slack trigger.
- In Endpoint & Contact Selection, for the Endpoints tab, search for and select the Slack service endpoints to receive this notification, which can include Slack services you created with Designating Slack as an endpoint to receive notifications.
Use the Revolution Slack app to initiate notifications without having to invoke the Revolution GUI.
The Revolution Slack app allows you to execute the following commands:
- /revolution help – returns a list of the commands you can run.
- /revolution status - returns information about any active notifications.
- /revolution sent - returns information about the last 10 notifications sent, including the Notification name, status information, time, and sender.
- /revolution activate - opens a dialog box allowing you to trigger a notification.
- Notification – Select a trigger that you created in Creating a Slack trigger.
- Title – Enter a string to be sent as the title. Notifications will use this string when you use the ActivatorTitle variable.
- Body – Enter a string to be sent as the body of the message. Notifications will use this string when you use the ActivatorBody variable.
- /revolution stop - Deactivates an activated notification sent with activate.
In some cases, you may not be able to use the Revolution Slack application. For those scenarios you can connect Revolution to Slack for posting notifications use a webhook created within Slack.
This functionality does not allow you to activate notifications within Slack.
Follow instructions from Slack for creating incoming webhooks to enable connections to Revolution. Refer to the Slack documentation: Getting started with Incoming Webhooks.
Set up an endpoint to use in a notification. Use this process to define the general appearance and format of your communication.
- Go to Configuration > Integrations > Collaboration > Slack
- Select New > New Slack Service
- For Name, enter a name for the service to make it easily identifiable. You will use this when creating notifications that post to Slack.
- For Posting Method, select Webhook.
- For Incoming Webhook URL, enter the webhook URL from Creating an Incoming Webhook URL for Slack.
- (optional) For Link, specify a URL to include at the end of any communication.
- Select Save
After creation, you can edit or delete the media service from the Webhook page under the Slack Service heading.
Add your collaboration service as an Endpoint to any existing or newly created notification.
You should not set your Slack Services as an endpoint on notifications that fire frequently.
- Go to Notifications > Manage.
- Select New Notification.
- Complete the General and Select Triggers sections as needed.
- For Message Details, remember that your media may use information from: Select Image, Title, and Body.
- For Endpoint & Contact Selection, search for and select the collaboration service you created with Creating a Slack service for use with a webhook from the Endpoints tab.
Use the Revolution application for Teams to activate notifications from Teams as well as sending any triggered notification to a Teams channel.
This flow guides you through the steps to install and set up the application within Teams, configure Revolution, and how to set up your notifications
You must manually install the Revolution application using a provided ZIP file.
Prerequisites: You must be the Org owner for the Teams space to install the app and your space must be connected to Office365 to ensure you can create Connectors.
-
Download the application ZIP file:
- Log in to your Teams space and select Apps from the left-hand column.
- Select Upload a custom app from the bottom of the Apps menu.
- Navigate to and open the downloaded ZIP file.
- Select the Revolution app from the Apps page and select Add to team.
- Select the Team/Channel for which you want to use the app and select Set up a bot.
-
Configure the app from the channel by entering:
configure @revolutionUse the Teams autocomplete feature when entering @revolution.
- You will then enter your AccountID and AuthGuid for your Revolution installation, which you can find in Global Settings > Licensing.
Set up an endpoint to use in a notification.
- Go to Configuration > Integrations > Collaboration > Teams
- Select New > New Teams Service
- For Name, enter a name for the service to make it easily identifiable. You will use this when creating notifications that post to Teams.
- For Posting Method, select App.
- For Channel, select the channel you want the notification to go to. You can choose from the list of available channels if you have installed the App and connected it to this Revolution server.
- (optional) For Link, specify a URL to include at the end of any communication.
- Select Save
After creation, you can edit or delete the service from the Webhook page under Teams Service heading.
Create this trigger for when you want to activate a notification from within Teams using the Mitel Revolution Teams application.
- Go to Configuration > Integrations > Collaboration > Teams
- Select New > New Teams Trigger
- For Name, enter a name for the service to make it easily identifiable. You will use this when completing the Select Triggers section when creating your notification.
For Available in All Sites:
- Enable to ensure all your site locations have access.
- Disable and select a Site to limit which site has access.
For Channels, select the channels from which you can activate notifications. Select any number of channels from the list of available channels.
If you do not identify any channels, you can activate notifications from any channel.
If you do not see a recently-added channel, run the @revolution update command in Teams.
For Members, select the users who can activate notifications. Select any number of users from the list of available users.
If you do not identify any users, all users can activate notifications.
- Select Save.
Add your Teams service as an endpoint to any existing or newly created notification.
You should not set your Teams service as an endpoint on notifications that fire frequently.
- Go to Notifications > Manage.
- Select New Notification.
- Complete the General and Select Triggers sections as needed.
- For Message Details, remember that your media may use information from: Select Image, Title, and Body.
- For Endpoint & Contact Selection, search for and select the collaboration service from the Endpoints tab.
This notification triggers off the Teams trigger you created in Creating a Teams trigger, which is used by the @revolution activate command in the Revolution Teams application.
- Go to Notifications > Manage.
- Select New Notification.
- Complete the General section as needed.
- In Select Triggers, For Activator, select Webhook, and for Trigger, select the trigger you created previously.
- In Message Details, complete Title, and Body, using static text or variables, which will use information from the Teams trigger.
- In Endpoint & Contact Selection, for the Endpoints tab, search for and select the endpoints to receive this notification, which can include Teams services you created with Creating a Teams service for use with the Revolution application.
Use the Revolution app within Teams to initiate notifications without having to invoke the Revolution GUI.
Note: Teams offers you autocomplete options when you enter the at symbol (@). Slowly start typing Revolution until the app is selected and then hit enter. Then start typing the command name and use the autocomplete selection.
The Revolution app for Teams allows you to execute the following commands:
- @revolution configure – Returns information about the application.
- @revolution status – Returns information about any active notifications, including the Notification name, status information, time, and sender.
- @revolution sent – Returns information about the last 10 notifications sent
- @revolution activate – Displays a dialog box allowing you to trigger a notification.
- Select an option – Select a trigger that you created in Creating a Teams trigger.
- Title – Enter a string to be sent as the title. Notifications will use this string when you use the ActivatorTitle variable.
- Body – Enter a string to be sent as the body of the message. Notifications will use this string when you use the ActivatorBody variable.
Select Activate to complete the process.
- @revolution update – Updates the list of available channels. If you have added a new Teams channel that you want to post to, use this command to see that channel.
- @revolution stop – Deactivates an activated notification sent with @revolution activate.
In some cases, you may not be able to use the Revolution Teams application. For those scenarios you can connect Revolution to Teams for posting notifications by using a webhook created within Teams.
This functionality does not allow you to activate notifications within Teams.
Prerequisites: Your Teams space must be connected to Microsoft Office365 to ensure you can create Connectors.
- Navigate to the channel where you want to add the webhook and select the More Options (...) icon from the top navigation bar.
- Choose Connectors from the drop-down menu and search for Incoming Webhook and select Configure.
- Provide a name, and, optionally, upload an image avatar for your webhook, then select Create.
- The dialog window will present a unique URL that will map to the channel. Make sure that you copy and save the URL, as you will need to provide it to Revolution.
- Select the Done button. The webhook will be available in the team channel.
You can also refer to the Microsoft Teams documentation: Post external requests to Teams with incoming webhooks.
Set up an endpoint to use in a notification.
- Go to Configuration > Integrations > Collaboration > Teams
- Select Webhook
- Select New > New Teams Service
- For Name, enter a name for the service to make it easily identifiable. You will use this when creating notifications that post to Teams.
- For Posting Method, select Webhook.
- For Incoming Webhook URL, enter the webhook URL you created.
- (optional) For Link, specify a URL to include at the end of any communication.
- Select Save
After creation, you can edit or delete the service from the Webhook page under Teams Service heading.
Add your Teams service as an Endpoint to any existing or newly created notification.
You should not set your Teams service as an endpoint on notifications that fire frequently.
- Go to Notifications > Manage.
- Select New Notification.
- Complete the General and Select Triggers sections as needed.
- For Message Details, remember that your media may use information from: Select Image, Title, and Body.
- For Endpoint & Contact Selection, search for and select the collaboration service from the Endpoints tab.
If you ever need to end a connection between Revolution and your collaboration tool service, you should use this process:
- Go to Configuration > Integrations > Token, find your token and select the delete icon.
-
Go to Configuration > Integrations > Collaboration > Teams or Slack, find your service entry and select the delete icon.
This will remove the endpoint from any notifications using it.
- Log into Slack or Teams and follow their processes for revoking access to Revolution, disabling the webhook, and remove the installed application.