Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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

  • Last tested Kanboard version is <=1.2.5 and >= 1.0.37
  • Zulip

The plugin is no longer updated and could run into issues on later Kanboard or Zulip versions if the integration code changes.

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 email and API key

Kanboard configuration

Individual notifications

  1. Copy and paste the webhook url into Integrations > Zulip > Webhook URL in your user profile in the format https://mydomain.myzulip.com/api/v1/messages
  2. Copy and paste the bot email and API key into Integrations > Zulip > Zulip Bot in your user profile in the format BOT_email:API_key
  3. Set the message type [stream/private]
  • if stream, set the zulip stream and subject name that should be used
  • if private message, set the zulip user email where the message should be sent to
  1. Enable Zulip notifications in your user profile or project settings
  2. Enjoy!

Project notification

  1. Copy and paste the webhook url into Integrations > Zulip > Webhook URL in the project settings in the format https://mydomain.myzulip.com/api/v1/messages
  2. Copy and paste the webhook url into Integrations > Zulip > Zulip Bot in the project settings in the format BOT_email:API_key
  3. Set the message type [stream/private]
  • if stream, set the zulip stream and subject name that should be used
  • if private message, set the zulip user email that message should be sent to
  1. Optionally set the event filter if required (see below)
  2. Enable Zulip notification in the project
  3. 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

About

Kanboard plugin to integrate with Zulip

Resources

License

Packages

No packages published