Slack notifications
- Robert Alexander Marshall
Notifications to a Slack channel are currently a Dark Feature that can be enabled in Comala Document Management 6.11.3.
Overview
Comala Document Management can be configured to provide notifications to a Slack channel when a workflow event occurs.
The Slack app is first created and installed at the Slack channel level using the Slack Web API Application creation feature for a Slack workspace.
In the Confluence instance
the global administrator must enable Slack notifications for the instance (enable Slack messaging as a dark mode feature in 6.11.3)
the webhook URL added to the Slack app can then be used in the Comala Slack macro to link a workflow to a Slack channel
The notifications posted to the Slack channel are created using workflow trigger actions to respond to workflow events including
state change events
page approval events
The following steps need to be undertaken to set up Slack notifications for your workflow
Configure dark mode Slack notification feature
This dark mode feature is only available from Comala Document Management 6.11.3.
A global administrator must enable the Comala Slack macro dark feature in the instance.
Set up a Slack channel for notifications
An empty Slack app must be created and a channel in the Slack workspace must be exposed. For more details see https://api.slack.com/messaging/webhooks.
In Slack, you need to
create an app
expose a channel in your Slack workspace by creating an incoming webhook for the app
The incoming webhook URL needs to be copied to add to your workflow trigger to create the notification.
Add one or more Slack notification triggers to your workflow
The slack-channel-message macro can be added to a trigger in your workflow. You must be able to access the Slack app in the Slack workspace to copy the webhook URL and edit the workflow.
copy the Slack webhook URL (webhook ID) created when you created the Slack app and exposed the channel in the Slack workspace
add the slack-channel-message macro including the webhook ID
{trigger:statechanged|state=Approved}
{slack-channel-message:webhook=https://hooks.slack.com/services/<webhook_ID>}
Here is my first slack notification. My @pagetitle@ content has just transitioned to the Approved state.
{slack-channel-message}
{trigger}
The trigger can be set to listen for several workflow events such as statechanged and pageapproved.