Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/half-shot/matrix-zammad
A zammad bot for matrix
https://github.com/half-shot/matrix-zammad
bot matrix zammad
Last synced: about 2 months ago
JSON representation
A zammad bot for matrix
- Host: GitHub
- URL: https://github.com/half-shot/matrix-zammad
- Owner: Half-Shot
- License: apache-2.0
- Created: 2019-12-16T10:11:11.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T12:52:13.000Z (almost 2 years ago)
- Last Synced: 2024-08-02T12:52:00.171Z (5 months ago)
- Topics: bot, matrix, zammad
- Language: TypeScript
- Homepage:
- Size: 262 KB
- Stars: 14
- Watchers: 6
- Forks: 2
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `matrix-zammad`
A bot for forwarding Zammad ticket notifications into Matrix.
## What is Zammad?
> [Zammad](https://zammad.org/) is a web-based, open source user support/ticketing solution.
- https://zammad.org/
## 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:```js
{
"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.