[PR #573] [MERGED] Add slack channel notification integration #1112

New Issue

OVERLORD · 2025-10-09T19:09:05+03:00

OVERLORD commented

2025-10-09 19:09:05 +03:00

📋 Pull Request Information

Original PR: https://github.com/plankanban/planka/pull/573
Author: @GlitchWitch
Created: 12/23/2023
Status: ✅ Merged
Merged: 4/8/2024
Merged by: @meltyshev

Base: master ← Head: slack-bot-integration

📝 Commits (8)

1043dac added new custom service with slack integration helper functions; added axios package; added notifications for card create, delete, and update (move); added notifications for comment create
f54bd22 removed test webhook url
9961340 Replace plankaProdUrl with one set by environment. Remove hardcoded channel and unused variables.
c42e1fb Add slack variables to docker-compose
3fedc14 Rename custom.js -> slack.js
a9c200c Merge branch 'master' into slack-bot-integration
86d21d6 updated to use currentUser.name for messages
273d994 Remove unused code and comments

📊 Changes

7 files changed (+98 additions, -0 deletions)

View changed files

📝 docker-compose.yml (+3 -0)
📝 package.json (+1 -0)
📝 server/api/controllers/cards/create.js (+7 -0)
📝 server/api/controllers/cards/delete.js (+7 -0)
📝 server/api/controllers/cards/update.js (+14 -0)
📝 server/api/controllers/comment-actions/create.js (+8 -0)
➕ server/api/services/slack.js (+58 -0)

📄 Description

Contributions primarily made by @chembrad44 of GlitchSecure

This PR adds a simple notification integration which will alert a specified slack channel on various actions.

A user must create a Slack App in their Slack instance with the chat:write scope and provide both the SLACK_BOT_TOKEN for the app and the SLACK_CHANNEL_ID for the channel they wish to have notifications arrive in.

Creating a slack app

Visit https://api.slack.com/apps
Choose "Create New App"->"From scratch"
Select your workspace
Visit the "OAuth & Permissions" tab
Select "Add an OAuth Scope" and enter chat:write
Install the app to your workspace and invite the bot to your channel
Copy the "Bot User OAuth Token" to the SLACK_BOT_TOKEN environment variable and the Channel ID to the SLACK_CHANNEL_ID environment variable.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/plankanban/planka/pull/573 **Author:** [@GlitchWitch](https://github.com/GlitchWitch) **Created:** 12/23/2023 **Status:** ✅ Merged **Merged:** 4/8/2024 **Merged by:** [@meltyshev](https://github.com/meltyshev) **Base:** `master` ← **Head:** `slack-bot-integration` --- ### 📝 Commits (8) - [`1043dac`](https://github.com/plankanban/planka/commit/1043dacd67d036e68f6bd5eb7b38ba85b74fbbc8) added new custom service with slack integration helper functions; added axios package; added notifications for card create, delete, and update (move); added notifications for comment create - [`f54bd22`](https://github.com/plankanban/planka/commit/f54bd227571bf869997004f304ad7a2a3d25c205) removed test webhook url - [`9961340`](https://github.com/plankanban/planka/commit/99613401183026d056184677e3b5efdab8df73ed) Replace plankaProdUrl with one set by environment. Remove hardcoded channel and unused variables. - [`c42e1fb`](https://github.com/plankanban/planka/commit/c42e1fb5dd8858f2b5a7b771d8798f1b5cb7a6f4) Add slack variables to docker-compose - [`3fedc14`](https://github.com/plankanban/planka/commit/3fedc140621550c6ba63ec2155ebd0948609f422) Rename custom.js -> slack.js - [`a9c200c`](https://github.com/plankanban/planka/commit/a9c200cc3bf1f49f0ccd29af9feca7f52f50c6e4) Merge branch 'master' into slack-bot-integration - [`86d21d6`](https://github.com/plankanban/planka/commit/86d21d6abda8eb268a320392d9c2f2caff91fbad) updated to use currentUser.name for messages - [`273d994`](https://github.com/plankanban/planka/commit/273d994750ed3fb5c8ae33078ee84452f7222576) Remove unused code and comments ### 📊 Changes **7 files changed** (+98 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `docker-compose.yml` (+3 -0) 📝 `package.json` (+1 -0) 📝 `server/api/controllers/cards/create.js` (+7 -0) 📝 `server/api/controllers/cards/delete.js` (+7 -0) 📝 `server/api/controllers/cards/update.js` (+14 -0) 📝 `server/api/controllers/comment-actions/create.js` (+8 -0) ➕ `server/api/services/slack.js` (+58 -0) </details> ### 📄 Description Contributions primarily made by @chembrad44 of [GlitchSecure](https://github.com/GlitchSecure) --- This PR adds a simple notification integration which will alert a specified slack channel on various actions. ![image](https://github.com/plankanban/planka/assets/32590246/af7b5ad5-41e8-4682-8fa7-79775b4bbd98) A user must create a Slack App in their Slack instance with the [chat:write](https://api.slack.com/scopes/chat:write) scope and provide both the `SLACK_BOT_TOKEN` for the app and the `SLACK_CHANNEL_ID` for the channel they wish to have notifications arrive in. ### Creating a slack app 1. Visit https://api.slack.com/apps 2. Choose "Create New App"->"From scratch" 3. Select your workspace 4. Visit the "OAuth & Permissions" tab 5. Select "Add an OAuth Scope" and enter `chat:write` 6. Install the app to your workspace and invite the bot to your channel 7. Copy the "Bot User OAuth Token" to the `SLACK_BOT_TOKEN` environment variable and the Channel ID to the `SLACK_CHANNEL_ID` environment variable. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

OVERLORD added the pull-request label 2025-10-09 19:09:05 +03:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/planka#1112