[PR #771] [MERGED] feat: event webhook #1094

Closed
opened 2026-02-04 21:49:45 +03:00 by OVERLORD · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/plankanban/planka/pull/771
Author: @HannesOberreiter
Created: 5/22/2024
Status: Merged
Merged: 6/6/2024
Merged by: @meltyshev

Base: masterHead: global-webhook


📝 Commits (10+)

  • bbf92f5 chore: add env variables
  • 9b52902 feat: create webhook util
  • 34709e2 feat: hook webhook to events
  • f5a8bd0 docs: 📝 add jsdoc
  • 5bf6505 refactor: ♻️ use keys for event and not the actual value
  • 4ad14ed fix: 🐛 add missing board ref and projectId to delete card
  • d989018 fix: 🐛 fix missing paths
  • 3a4fe74 fix: 🐛 fix wrong key names
  • fb6ce10 fix: 🐛 fix actions
  • 5a11d56 feat: add user create event

📊 Changes

38 files changed (+416 additions, -9 deletions)

View changed files

📝 server/.env.sample (+3 -0)
📝 server/api/controllers/attachments/create.js (+2 -1)
📝 server/api/controllers/card-memberships/create.js (+2 -1)
📝 server/api/controllers/card-memberships/delete.js (+2 -1)
📝 server/api/controllers/comment-actions/delete.js (+2 -1)
📝 server/api/controllers/comment-actions/update.js (+2 -1)
📝 server/api/controllers/lists/delete.js (+3 -1)
📝 server/api/controllers/lists/update.js (+3 -1)
📝 server/api/controllers/tasks/create.js (+2 -1)
📝 server/api/helpers/actions/create-one.js (+9 -0)
📝 server/api/helpers/actions/delete-one.js (+13 -0)
📝 server/api/helpers/actions/update-one.js (+13 -0)
📝 server/api/helpers/attachments/create-one.js (+16 -1)
📝 server/api/helpers/attachments/delete-one.js (+9 -0)
📝 server/api/helpers/attachments/update-one.js (+8 -0)
📝 server/api/helpers/boards/create-one.js (+8 -0)
📝 server/api/helpers/boards/delete-one.js (+8 -0)
📝 server/api/helpers/boards/update-one.js (+8 -0)
📝 server/api/helpers/card-memberships/create-one.js (+13 -0)
📝 server/api/helpers/card-memberships/delete-one.js (+13 -0)

...and 18 more files

📄 Description

This pull request reintroduces webhook functionality as a replacement for the functionality addressed in PR #691 (since closed).

Key Features:

  • Centralised Webhook Utility: A new utility is created to send relevant actions to a user-defined webhook URL.
  • Environment Variable Configuration: The webhook URL and optional bearer token can be easily configured through environment variables.
  • Flexible Integrations: This implementation aims to facilitate various integrations by allowing users to build custom notification systems.

Progress:

  • created webhook utility
  • tested all endpoints
  • (optional) add more events, eg. user created
  • (optional) simplify logic by implementing a middleware

🔄 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/771 **Author:** [@HannesOberreiter](https://github.com/HannesOberreiter) **Created:** 5/22/2024 **Status:** ✅ Merged **Merged:** 6/6/2024 **Merged by:** [@meltyshev](https://github.com/meltyshev) **Base:** `master` ← **Head:** `global-webhook` --- ### 📝 Commits (10+) - [`bbf92f5`](https://github.com/plankanban/planka/commit/bbf92f5089c61bcf582fe8d67e43fde68e8cd300) chore: add env variables - [`9b52902`](https://github.com/plankanban/planka/commit/9b529024a046b640755085978e806666b1ce43ef) feat: :sparkles: create webhook util - [`34709e2`](https://github.com/plankanban/planka/commit/34709e26af9e78c2cd9d13bb2d9e136d8123d063) feat: :sparkles: hook webhook to events - [`f5a8bd0`](https://github.com/plankanban/planka/commit/f5a8bd0bced5a974f7f05ac46d2aad4924e02f3f) docs: :memo: add jsdoc - [`5bf6505`](https://github.com/plankanban/planka/commit/5bf6505656199332331bde1115f2084c9e3bf0ba) refactor: :recycle: use keys for event and not the actual value - [`4ad14ed`](https://github.com/plankanban/planka/commit/4ad14ed4145bc97066c6c964e006914af36acbfc) fix: :bug: add missing board ref and projectId to delete card - [`d989018`](https://github.com/plankanban/planka/commit/d9890181b7922cb2adce81c107c1627755c34aef) fix: :bug: fix missing paths - [`3a4fe74`](https://github.com/plankanban/planka/commit/3a4fe74c0a85867183ab9da4e03bc0640d6cf897) fix: :bug: fix wrong key names - [`fb6ce10`](https://github.com/plankanban/planka/commit/fb6ce105f9926738ad36f67a478cd45864e2df63) fix: :bug: fix actions - [`5a11d56`](https://github.com/plankanban/planka/commit/5a11d563bcbaf634ceeaf0ae137a5304571cb1cc) feat: :sparkles: add user create event ### 📊 Changes **38 files changed** (+416 additions, -9 deletions) <details> <summary>View changed files</summary> 📝 `server/.env.sample` (+3 -0) 📝 `server/api/controllers/attachments/create.js` (+2 -1) 📝 `server/api/controllers/card-memberships/create.js` (+2 -1) 📝 `server/api/controllers/card-memberships/delete.js` (+2 -1) 📝 `server/api/controllers/comment-actions/delete.js` (+2 -1) 📝 `server/api/controllers/comment-actions/update.js` (+2 -1) 📝 `server/api/controllers/lists/delete.js` (+3 -1) 📝 `server/api/controllers/lists/update.js` (+3 -1) 📝 `server/api/controllers/tasks/create.js` (+2 -1) 📝 `server/api/helpers/actions/create-one.js` (+9 -0) 📝 `server/api/helpers/actions/delete-one.js` (+13 -0) 📝 `server/api/helpers/actions/update-one.js` (+13 -0) 📝 `server/api/helpers/attachments/create-one.js` (+16 -1) 📝 `server/api/helpers/attachments/delete-one.js` (+9 -0) 📝 `server/api/helpers/attachments/update-one.js` (+8 -0) 📝 `server/api/helpers/boards/create-one.js` (+8 -0) 📝 `server/api/helpers/boards/delete-one.js` (+8 -0) 📝 `server/api/helpers/boards/update-one.js` (+8 -0) 📝 `server/api/helpers/card-memberships/create-one.js` (+13 -0) 📝 `server/api/helpers/card-memberships/delete-one.js` (+13 -0) _...and 18 more files_ </details> ### 📄 Description This pull request reintroduces webhook functionality as a replacement for the functionality addressed in PR [#691](https://github.com/plankanban/planka/pull/691) (since closed). ## Key Features: - Centralised Webhook Utility: A new utility is created to send relevant actions to a user-defined webhook URL. - Environment Variable Configuration: The webhook URL and optional bearer token can be easily configured through environment variables. - Flexible Integrations: This implementation aims to facilitate various integrations by allowing users to build custom notification systems. ## Progress: - [x] created webhook utility - [x] tested all endpoints - [x] (optional) add more events, eg. user created - [ ] (optional) simplify logic by implementing a middleware --- <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 2026-02-04 21:49:45 +03:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/planka#1094