https://github.com/matrix-org/matrix-sentry-webhooks

Sentry webhooks integration bot for Matrix.
https://github.com/matrix-org/matrix-sentry-webhooks

bot integration matrix sentry webhook

Last synced: 1 day ago
JSON representation

Sentry webhooks integration bot for Matrix.

• Host: GitHub
• URL: https://github.com/matrix-org/matrix-sentry-webhooks
• Owner: matrix-org
• License: other
• Created: 2020-04-08T13:00:12.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-04-14T16:15:23.000Z (over 1 year ago)
• Last Synced: 2024-05-08T20:22:25.142Z (6 months ago)
• Topics: bot, integration, matrix, sentry, webhook
• Language: JavaScript
• Size: 408 KB
• Stars: 17
• Watchers: 7
• Forks: 7
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Matrix Sentry Webhooks

A bot to receive Sentry webhook events and forward them to chosen rooms.

Main features:

* Supports both Integration Platform webhooks and legacy webhook events.

* Uses pre-created Matrix user to send alerts using token auth

* Configurable room per alert receiver

* Automatic joining of configured rooms on start up (invite needed for private rooms)

* Verification of messages against the Sentry client key or `secret` query param for

  legacy integrations

* HTML formatted messages

## How to use

### Configuration

Whether running manually or via the Docker image, the configuration is set via 

environment variables. When running manually, copy `.env.default` into `.env`, 

set the values and they will be loaded automatically. When using the Docker image, 

set the environment variables when running the container.

### Docker

The Docker image is the easiest way to get the service running. 

Ensure you set the required environment variables listed in `.env.default` in this 

repository.

Docker images can be found on [Docker Hub](https://hub.docker.com/r/matrixdotorg/matrix-sentry-webhooks).

### Sentry

The URL for both Integration Platform events and legacy webhook events is the following,

replacing `yourdomain.here` with your domain where the bot runs:

    https://yourdomain.here/receive

NOTE! The bot cannot talk HTTPS, so you need to have a reverse proxy in place to 

terminate SSL.

#### Integration platform

You'll need the Sentry Client Secret to be placed as the `SENTRY_CLIENT_SECRET`

environment variables. The bot will verify the signature of payloads by comparing

to a digest sent by Sentry in the request headers.

#### Legacy webhook events

You will need to configure a webhook integration in Sentry. 

Go to project "Settings" -> "Legacy integrations" -> "Webhooks". Enable for the

project and add an url pointing to your bot, postfixing the url with the query

parameter `?secret=foobar`, replacing `foobar` with a secret of your choice,

matching what is set as `SENTRY_CLIENT_SECRET` for the bot. Note, this does

not have to correlate with any real Sentry client secret.

## TODO

* Registering an account instead of having to use an existing account

## License

Apache 2.0