Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lukasknuth/gotify-slack-webhook
A Gotify Plugin to accept Slack Incoming Webhooks
https://github.com/lukasknuth/gotify-slack-webhook
gotify-plugin slack-webhook
Last synced: 19 days ago
JSON representation
A Gotify Plugin to accept Slack Incoming Webhooks
- Host: GitHub
- URL: https://github.com/lukasknuth/gotify-slack-webhook
- Owner: LukasKnuth
- License: mit
- Created: 2024-07-20T21:07:30.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-08-21T20:14:27.000Z (4 months ago)
- Last Synced: 2024-12-09T09:07:10.621Z (25 days ago)
- Topics: gotify-plugin, slack-webhook
- Language: Go
- Homepage:
- Size: 269 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Gotify Slack Webhook
Allows Gotify to receive [Slack Incoming Webhooks](https://api.slack.com/messaging/webhooks).
**Support**
- Read-only blocks from [Slack Block Kit](https://api.slack.com/reference/block-kit/blocks)
- Buttons pointing to URLs
- Handles any non-supported block by stripping it
- Does **NOT** implement any Slack specific interaction blocks (these are stripped)
**Rational**
Many services already integrate with Slack using Incoming Webhooks. If they don't directly integrate with Gotify, you can configure the Slack Webhook URL to this Plugin and receive the messages meant for Slack in Gotify.
## Setup
### Installation
**Either** build the plugin yourself or download a [binary release](https://github.com/LukasKnuth/gotify-slack-webhook/releases). Make the `.so` file available to Gotify in it's `pluginsdir` (default `/data/plugins`).
**Or**, use the pre-bundled Gotify Server Image built for each release: `ghcr.io/lukasknuth/gotify-slack-webhook-bundled` from [packages](https://github.com/LukasKnuth/gotify-slack-webhook/pkgs/container/gotify-slack-webhook-bundled).
### Configuration
1. Launch Gotify and verify the plugin is loaded in the log:
```
Starting Gotify version 2.5.0@2024-06-23-17:12:59
Loading plugin data/plugins/gotify-slack-webhook-linux-arm64.so
Started listening for plain connection on tcp [::]:80
```
4. Navigate to "Plugins" and enable the "Slack Incoming Webhook Support" plugin
5. Click the :gear: icon next to it and note the Webhook URL
6. Under "Apps" create an App for each service and copy the token
```
http://my.gotify.de/plugin/1/custom/unique-to-your-install/webhook/slack/app-token-here
```
7. In the service you want to integrate, configure the full URL as the Slack Incoming Webhook
8. Done
### Example Payload
This is the same payload as used in the above screenshot:
```json
{
"blocks": [
{
"type": "header",
"text": {
"type": "plain_text",
"text": "Something is very wrong!",
"emoji": true
}
},
{
"type": "section",
"text": {
"type": "plain_text",
"text": "Observed Issue during Litestream replication"
},
"fields": [
{
"type": "mrkdwn",
"text": "*Severity*: ERROR"
},
{
"type": "mrkdwn",
"text": "*Occurence*: 4"
}
],
"accessory": {
"type": "button",
"text": {
"type": "plain_text",
"text": "More Information",
"emoji": true
},
"url": "http://fluent.bit/asdf123"
}
}
]
}
```
You can build messages interactively in the [Block Kit Builder](https://app.slack.com/block-kit-builder/) and try them out yourself.
### Restrictions
We're sending REST API requests to the local running Gotify instance. For this to work, two [settings](https://gotify.net/docs/config) are crucial:
- If you must change the port, set `GOTIFY_SERVER_PORT` ENV variable instead of using the YAML file
- You may not change the `server.listenaddr` or `GOTIFY_SERVER_LISTENADDR`, the server must listen on `localhost/127.0.0.1`
NOTE: Neither of these apply to the **default configuration** of the server.
## References
- [Slack Incoming Webhook documentation](https://api.slack.com/messaging/webhooks)
- [Slack BlockKit](https://api.slack.com/block-kit)
- [Gotify Plugin - Getting started](https://gotify.net/docs/plugin)
- [Gotify Plugin - Reference](https://gotify.net/docs/plugin-write)
- [Gotify Plugin API](https://pkg.go.dev/github.com/gotify/plugin-api)
- [Gotify Plugin Template](https://github.com/gotify/plugin-template)
- [Gin Web Framework](https://gin-gonic.com/docs/examples/param-in-path/) - For the Webhook integration