diff --git a/website/docs/assets/slack_project.png b/website/docs/assets/slack_project.png new file mode 100644 index 0000000000..0c608759f8 Binary files /dev/null and b/website/docs/assets/slack_project.png differ diff --git a/website/docs/assets/slack_system.png b/website/docs/assets/slack_system.png new file mode 100644 index 0000000000..31183206c9 Binary files /dev/null and b/website/docs/assets/slack_system.png differ diff --git a/website/docs/assets/slack_token.png b/website/docs/assets/slack_token.png new file mode 100644 index 0000000000..b88b35deb3 Binary files /dev/null and b/website/docs/assets/slack_token.png differ diff --git a/website/docs/module_slack.md b/website/docs/module_slack.md new file mode 100644 index 0000000000..c8e42ababa --- /dev/null +++ b/website/docs/module_slack.md @@ -0,0 +1,55 @@ +--- +id: module_site_sync +title: Slack Integration Administration +sidebar_label: Slack +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + +This module allows configuring profiles(when to trigger, for which combination of task, host and family) +and templates(could contain {} placeholder) to send notification to Slack channel(s) +whenever configured asset type is published. + + +## App installation + +Slack application must be installed to company's Slack first. + +Please locate `openpype/modules/slack/manifest.yml` file in deployed OpenPype installation and follow instruction at +https://api.slack.com/reference/manifests#using + + +## System Settings + +To use notifications, *Slack Notifications* needs to be enabled globally in **OpenPype Settings/System/Modules/Slack Notifications**. + +![Configure module](assets/slack_system.png) + + +## Project Settings + +### Token +Most important for module to work is to fill authentication token +```Project settings > Slack > Publish plugins > Token``` + +This token should be available after installation of the app in the Slack dashboard. +It is possible to create multiple tokens and configure different scopes for them. + +![Get token](assets/slack_token.png) + +### Profiles +Profiles are used to select when to trigger notification. One or multiple profiles +could be configured, `Families`, `Task names` (regex available), `Host names` and host combination is needed. + +Eg. If I want to be notified when render is published from Maya, setting is: + +- family: 'render' +- host: 'Maya' + +### Channel +Message could be delivered to one or multiple channels, by default app allows Slack bot +to send messages to 'public' channels (eg. bot doesn't need to join the channel first). + +![Configure module](assets/slack_system.png)