https://github.com/matrix-org/matrix-hookshot

A bridge between Matrix and multiple project management services, such as GitHub, GitLab and JIRA.
https://github.com/matrix-org/matrix-hookshot

Last synced: 12 days ago
JSON representation

A bridge between Matrix and multiple project management services, such as GitHub, GitLab and JIRA.

• Host: GitHub
• URL: https://github.com/matrix-org/matrix-hookshot
• Owner: matrix-org
• License: apache-2.0
• Created: 2019-08-02T18:07:04.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T11:07:58.000Z (6 months ago)
• Last Synced: 2024-10-29T13:08:29.047Z (6 months ago)
• Language: TypeScript
• Homepage: https://matrix-org.github.io/matrix-hookshot/
• Size: 9.29 MB
• Stars: 289
• Watchers: 13
• Forks: 68
• Open Issues: 298
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-matrix-bots - Matrix Hookshot (The Matrix.org foundation)
• awesome-matrix-bots - Matrix Hookshot (The Matrix.org foundation)

README

        
![logo](logo.png) Matrix Hookshot

===============

[![#hookshot:half-shot.uk](https://img.shields.io/matrix/hookshot:half-shot.uk.svg?server_fqdn=chaotic.half-shot.uk&label=%23hookshot:half-shot.uk&logo=matrix)](https://matrix.to/#/#hookshot:half-shot.uk)

[![Docker Image Version (latest by date)](https://img.shields.io/docker/v/halfshot/matrix-hookshot?sort=semver)](https://hub.docker.com/r/halfshot/matrix-hookshot)

![screenshot](screenshot.png)

A Matrix bot for connecting to external services like GitHub, GitLab, JIRA, and more.

- Several services are supported out of the box.

- [Webhooks](https://matrix-org.github.io/matrix-hookshot/latest/setup/webhooks.html) let you connect all kinds of services, with the ability to write rich templates using JavaScript.

- **No external database** is required, instead using Matrix state as a persistent store.

- End-to-Bridge encryption allows bots to be used in encrypted Matrix rooms.

- [Powerful widgets](https://matrix-org.github.io/matrix-hookshot/latest/advanced/widgets.html) let you configure Hookshot from a room or the Element Extensions Store.

We richly support the following integrations:

- [Challenge Hound](https://matrix-org.github.io/matrix-hookshot/latest/setup/challengehound.html)

- [Figma](https://matrix-org.github.io/matrix-hookshot/latest/setup/figma.html)

- [Generic Webhooks](https://matrix-org.github.io/matrix-hookshot/latest/setup/webhooks.html)

- [GitHub](https://matrix-org.github.io/matrix-hookshot/latest/setup/github.html)

- [GitLab](https://matrix-org.github.io/matrix-hookshot/latest/setup/gitlab.html)

- [Jira](https://matrix-org.github.io/matrix-hookshot/latest/setup/jira.html)

- [RSS/Atom feeds](https://matrix-org.github.io/matrix-hookshot/latest/setup/feeds.html)

Get started by reading [the setup guide](https://matrix-org.github.io/matrix-hookshot/latest/setup.html)!

## Documentation

Documentation can be found on [GitHub Pages](https://matrix-org.github.io/matrix-hookshot).

You can build the documentation yourself by typing:

```sh

# cargo install mdbook

mdbook build

sensible-browser book/index.html

```

## Contact

We have a Matrix support room ([#hookshot:half-shot.uk](https://matrix.to/#/#hookshot:half-shot.uk)).