Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/didil/inhooks
Incoming Webhooks Gateway built with Go. Uses Redis for storage/queueing.
https://github.com/didil/inhooks
gateway golang redis webhook webhooks
Last synced: about 2 hours ago
JSON representation
Incoming Webhooks Gateway built with Go. Uses Redis for storage/queueing.
- Host: GitHub
- URL: https://github.com/didil/inhooks
- Owner: didil
- License: lgpl-3.0
- Created: 2023-04-29T08:02:52.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-10T06:37:41.000Z (4 months ago)
- Last Synced: 2024-07-10T08:38:01.093Z (4 months ago)
- Topics: gateway, golang, redis, webhook, webhooks
- Language: Go
- Homepage:
- Size: 324 KB
- Stars: 42
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.gnu.org/licenses/lgpl-3.0)
[](https://coveralls.io/github/didil/inhooks?branch=main)
# Inhooks
Inhooks aims to be a lightweight incoming webhooks gateway solution. Written in Go and runnable as a single binary or docker container. Only requires a redis database for storage/queueing.
You can read more about inhooks in the [launch blog post](https://didil.medium.com/inhooks-3983b68274e1).
*Note: This software is still early in its development cycle / not battle-tested. Test thoroughly before using in production systems.*
## Architecture
### High level overview
Inhooks consists of two major concepts, Sources and Sinks. A Source is an endpoint for receiving webhooks, and a [Sink](https://en.wikipedia.org/wiki/Sink_(computing)) is a target that receives the webhooks.
Inhooks listens to HTTP webhooks and saves the messages to Redis. A processing module retrieves the messages and sends them reliably to the defined sinks.
## Features
- Receive HTTP Webhooks and save them to a Redis database
- Fanout messages to multiple HTTP targets (sinks)
- Fast, concurrent processing
- Supports delayed processing
- Supports retries on failure with configurable number of attempts, interval and constant or exponential backoff
- Supports different HTTP payloads types: JSON, x-www-form-urlencoded, multipart/form-data
- Supports message transformation using JavaScript ECMAScript 5.1
- ... more features planned
## Downloading release binaries
The release binaries are available on the [GitHub releases](https://github.com/didil/inhooks/releases) page.
To download a specific version, adjust then env vars below and run:
```shell
export INHOOKS_VERSION="0.1.9"
export OS="linux"
export ARCH="amd64"
curl -LO https://github.com/didil/inhooks/releases/download/v${INHOOKS_VERSION}/inhooks_${INHOOKS_VERSION}_${OS}_${ARCH}.tar.gz
tar -xvzf inhooks_${INHOOKS_VERSION}_${OS}_${ARCH}.tar.gz
```
## Usage
### Inhooks config
The inhooks config file allows setting up the Source to Sink flows.
Create a file named inhooks.yml in the folder where the inhooks server will run (configurable via the INHOOKS_CONFIG_FILE env variable).
Example inhooks.yml config
``` yaml
flows:
- id: flow-1
source:
id: source-1
slug: source-1-slug
type: http
sinks:
- id: sink-1
type: http
url: https://example.com/target
delay: 90s # delay processing by 90 seconds
- id: sink-2
type: http
url: https://example.com/othertarget
retryInterval: 5m # on error, retry after 5 minutes
# retryExpMultiplier: 2 # exponential backoff
maxAttempts: 10 # maximum number of attempts
```
With this config, inhooks will listen to http POST requests to `/api/v1/ingest/source-1-slug`.
When a message is received, it is saved to the redis database. Then inhooks tries to send it to each of the urls defined in the sinks section of the config.
In case of failures, retries are attempted based on the sink config params.
If the config is modifed, the server must be restarted to load the new config.
### Env vars
Copy the .env examples to init the .env file and update as needed (to set the inhooks config file path, the redis url, the server port, etc).
```shell
cp .env.example .env
```
### Securing webhooks
If you would like to verify your webhooks with HMAC 256, you can use the following configuration:
``` yaml
flows:
- id: flow-1
source:
id: source-1
slug: source-1-slug
type: http
verification:
verificationType: hmac # only option supported at the moment
hmacAlgorithm: sha256 # only option supported at the moment
signatureHeader: x-my-header # the name of the http header in the incoming webhook that contains the signature
signaturePrefix: "sha256=" # optional signature prefix that is required for some sources, such as github for example that uses the prefix 'sha256='
currentSecretEnvVar: VERIFICATION_FLOW_1_CURRENT_SECRET # the name of the environment variable containing the verification secret
previousSecretEnvVar: VERIFICATION_FLOW_1_PREVIOUS_SECRET # optional env var that allows rotating secrets without service interruption
```
### Message transformation
#### Transform definition
Message transformation allows you to modify the payload and headers of messages before they are sent to the sinks (destinations). This can be useful for tasks such as adding or removing fields, changing the format of the data, or adding custom headers.
Currently, only JavaScript transformations are supported. The JavaScript function should be named `transform` and should take two parameters: `bodyStr` (the message body as a string) and `headers` (the message headers as a JSON object). The function should return an array with two elements: the transformed payload as a string and the transformed headers as a JSON object.
The `headers` fields has the following format:
```
{
"header-name": ["value1", "value2"]
}
```
Only JavaScript ECMAScript 5.1 is supported at the moment. We use the [goja](https://github.com/dop251/goja) library to execute the JavaScript code. You can read about the limitations on goja's documentation pages.
Here is an example configuration:
```yaml
flows:
- id: flow-1
source:
id: source-1
slug: source-1-slug
type: http
sinks:
- id: sink-1
type: http
url: https://example.com/target
transform:
id: js-transform-1
transform_definitions:
- id: js-transform-1
type: javascript
script: |
function transform(bodyStr, headers) {
const body = JSON.parse(bodyStr);
// add a header
headers["X-INHOOKS-TRANSFORMED"] = ["1"];
// capitalize the message if present
if (body.msg) {
body.msg = body.msg.toUpperCase();
}
// delete a key from the body
delete body.my_dummy_key;
return [JSON.stringify(body), headers];
}
```
#### Testing transform scripts
You can use the `/api/v1/transform` endpoint to test your transform scripts before adding them to your flow configuration. This endpoint allows you to simulate the transformation process and see the results immediately.
To use this endpoint, send a POST request with a JSON payload containing the following fields:
- `body`: The message body as a string
- `headers`: The message headers as a JSON object
- `transformDefinition`: An object containing the `type` and `script` of your transformation
Here's an example of how to use the `/api/v1/transform` endpoint:
```shell
curl -X POST http://localhost:3000/api/v1/transform \
-H "Content-Type: application/json" \
-d '{
"body": "{\"msg\": \"hello world\", \"my_dummy_key\": \"value\"}",
"headers": {"Content-Type": ["application/json"]},
"transformDefinition": {
"type": "javascript",
"script": "function transform(bodyStr, headers) { const body = JSON.parse(bodyStr); headers[\"X-INHOOKS-TRANSFORMED\"] = [\"1\"]; if (body.msg) { body.msg = body.msg.toUpperCase(); } delete body.my_dummy_key; return [JSON.stringify(body), headers]; }"
}
}'
```
### Prometheus metrics
Inhooks exposes Prometheus metrics at the `/api/v1/metrics` endpoint.
## Development setup
### Tools
Go 1.20+ and Redis 6.2.6+ are required
Install tools
```shell
make install-tools
```
### Env
Copy the .env examples to init the .env files
```shell
cp .env.example .env
cp .env.test.example .env.test
```
### Run tests
```shell
make test
```
### Run linter
```shell
make lint
```
### Run Dev Server
```shell
make run-dev
```
### Run Docker Compose
```shell
docker-compose up
```
## Contributing
Feel free to open new issues or PRs ! You can also reach out to the maintainer at the email address: [email protected]
## License
Copyright (c) 2023 Adil H.
Inhooks is an Open Source project licensed under the terms of the LGPLv3 license.
Please see [LICENSE](LICENSE) for the full license text.