Skip to content

Half-Shot/matrix-zammad

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

matrix-zammad

A bot for forwarding Zammad ticket notifications into Matrix.

What is Zammad?

Zammad is a web-based, open source user support/ticketing solution.

Features

  • Notifies on new ticket creation in a given group

Running / Building

git clone https://github.com/Half-Shot/matrix-zammad.git

Copy the config/default.yaml to config/production.yaml and edit as appropriate.

yarn
yarn build
yarn start

Configuration

Beyond configuring the bot in config/production.yaml, you need to also configure the rooms.

The bot uses Matrix room state for configuration. To setup a room (in Riot):

  • Open the room that you wish to connect the bot to.
  • Invite the bot.
  • Add a new state event uk.half-shot.matrix-zammad.roominfo with the content:
{
    "type": "stream",
    "pollInterval": 10000 // ms to wait between fetches for tickets.
    "groupId": 2 // The group_id you wish to fetch the tickets of. See https://docs.zammad.org/en/latest/api-group.html#list to find your group.
}
  • Start the bot (ensuring you've added the room's roomId to the rooms list in the config)
  • New tickets should start to be reported in the room.

Help!

There is no help for you yet, traveller.

Releases

No releases published

Packages

No packages published