Skip to content
Kanboard plugin to integrate with Zulip
Branch: master
Clone or download
Latest commit 0ec5450 Feb 25, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Locale
Notification
Template
Test
LICENSE
Makefile Updated all mentions of Mattermost to Zulip Feb 18, 2019
Plugin.php Added filter option to limit events triggering comment Feb 21, 2019
README.md Update README.md Feb 25, 2019
zulip-icon.png

README.md

Zulip plugin for Kanboard

Receive Kanboard notifications on Zulip.

You can configure Zulip notifications for a project or for each individual Kanboard user.

Author

  • Frédéric Guillot (for cloning the original Mattermost plugin)
  • Peter Fejer
  • License MIT

Requirements

  • Kanboard >= 1.0.37
  • Zulip

Installation

You have the choice between 3 methods:

  1. Install the plugin from the Kanboard plugin manager in one click
  2. Download the zip file and decompress everything under the directory plugins/Zulip
  3. Clone this repository into the folder plugins/Zulip

Note: Plugin folder is case-sensitive.

Configuration

Zulip configuration

  • Generate a new incoming webhook bot on Zulip (Settings > Your bots)
  • Copy the bot name and API key

Kanboard configuration

Individual notifications

  1. Copy and paste the bot name and API key into Integrations > Zulip in your user profile
  2. Set the channel and subject name that should be used
  3. Enable Zulip notifications in your user profile or project settings
  4. Enjoy!

Project notification

  1. Copy and paste the webhook url into Integrations > Zulip in the project settings
  2. Add the channel name (Optional)
  3. Enable Zulip notification in the project
  4. Enjoy!

Adding event filters

You might want to filter down the events that trigger a push. You use the optional filter entry for this. If no filter is added then every event will trigger a push notification. If you add one (or more) events then ONLY those events will trigger the notification.

To use them, add the filters separated with a comma for example: task.create,task.move.column

The following events can be added to the filter:

  • task.move.column - Move a task to another column
  • task.update - Task modification
  • task.create - Task creation
  • task.open - Reopen a task
  • task.close - Closing a task
  • task.assignee_change - Task assignee change
  • task.move.swimlane - Move a task to another swimlane
You can’t perform that action at this time.