https://github.com/webhookx-io/webhookx
an open-source webhooks gateway for message receiving, processing, and delivering.
https://github.com/webhookx-io/webhookx
cloud-native docker gateway golang webhooks webhookx
Last synced: 3 months ago
JSON representation
an open-source webhooks gateway for message receiving, processing, and delivering.
- Host: GitHub
- URL: https://github.com/webhookx-io/webhookx
- Owner: webhookx-io
- License: apache-2.0
- Created: 2024-07-16T16:29:33.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-03-05T09:17:00.000Z (4 months ago)
- Last Synced: 2025-03-05T09:20:48.322Z (4 months ago)
- Topics: cloud-native, docker, gateway, golang, webhooks, webhookx
- Language: Go
- Homepage: https://webhookx.io
- Size: 442 KB
- Stars: 136
- Watchers: 3
- Forks: 13
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- trackawesomelist - WebhookX (⭐111) - A webhooks gateway for message receiving, processing, and reliable delivering. (Recently Updated / [Dec 24, 2024](/content/2024/12/24/README.md))
README
# WebhookX [](https://github.com/webhookx-io/webhookx/releases) [](https://github.com/webhookx-io/webhookx/actions/workflows/test.yml) [](https://github.com/webhookx-io/webhookx/actions/workflows/lint.yml) [](https://goreportcard.com/report/github.com/webhookx-io/webhookx) [](https://codecov.io/gh/webhookx-io/webhookx) [](https://github.com/avelino/awesome-go)
[](https://join.slack.com/t/webhookx/shared_invite/zt-2o4b6hv45-mWm6_WUcQP9qEf1nOxhrrg) [](https://twitter.com/webhookx)
WebhookX is an open-source webhooks gateway for message receiving, processing, and delivering.
## Features
- **Admin API:** The admin API(:8080) provides a RESTful API for webhooks entities management.
- **Retries:** WebhookX automatically retries unsuccessful deliveries at configurable delays.
- **Fan out:** Events can be fan out to multiple destinations.
- **Declarative configuration:** Managing your configuration through declarative configuration file, and be GitOps and DevOps compliant.
- **Multi-tenancy:** Multi-tenancy is supported with workspaces. Workspaces provide an isolation of configuration entites.
- **Plugins:**
- `webhookx-signature`: signing outbound requests with HMAC(SHA-256) by adding `Webhookx-Signature` and `Webhookx-Timestamp` to request header.
- `transformer`(WIP): transform request before sending outbound requests.
- **Observability:** OpenTelemetry Metrics and Tracing.
## Roadmap
- [ ] Data retention policy
- [ ] Insight admin APIs
#### Inbound
- [ ] Middlewares/Plugins
- [ ] Authentication
- [ ] Event Transformer
## Installation
### macOS
```shell
$ brew tap webhookx-io/webhookx
$ brew install webhookx
```
### Linux
- Download the binary distribution on [releases](https://github.com/webhookx-io/webhookx/releases).
### Windows:
- Download the binary distribution on [releases](https://github.com/webhookx-io/webhookx/releases).
## Getting started
#### 1. Running WebhookX
```
$ curl -O https://raw.githubusercontent.com/webhookx-io/webhookx/main/docker-compose.yml
$ docker compose up
```
verify running
```
$ curl http://localhost:8080
```
#### 2. Setup configuration
```
$ webhookx admin sync webhookx.sample.yml
```
#### 3. Send an event to the Proxy (port 8081)
```
$ curl -X POST http://localhost:8081 \
--header 'Content-Type: application/json' \
--data '{
"event_type": "charge.succeeded",
"data": {
"key": "value"
}
}'
```
#### 4. Retrieve delivery attempts
> Attempt represents an event delivery attempt, and contains inspection information of a delivery.
```
$ curl http://localhost:8080/workspaces/default/attempts
```
See response
```json
{
"total": 1,
"data": [
{
"id": "2mYwlR8U5FS6VfK3AHLrYZL75MD",
"event_id": "2mYwlQZgpNSHTuDr9ApNgvL95x3",
"endpoint_id": "2mYwjjwRGCwDhtdTtOrVQYETzVt",
"status": "SUCCESSFUL",
"attempt_number": 1,
"scheduled_at": 1727266967962,
"attempted_at": 1727266968826,
"trigger_mode": "INITIAL",
"exhausted": false,
"error_code": null,
"request": {
"method": "POST",
"url": "https://httpbin.org/anything",
"headers": null,
"body": null
},
"response": {
"status": 200,
"latency": 8573,
"headers": null,
"body": null
},
"created_at": 1727238167962,
"updated_at": 1727238167962
}
]
}
```
Explore more API at [openapi.yml](/openapi.yml).
## CLI
[CLI Reference](https://webhookx.io/docs/cli)
## Runtime dependencies
The gateway requires the following runtime dependencies to work:
- PostgreSQL(>=13): Lower versions of PostgreSQL may work, but have not been fully tested.
- Redis(>=6.2)
## Status and Compatibility
The project is currently under active development, hence breaking changes may be introduced in minor releases.
The public API will strictly follow semantic versioning after `v1.0.0`.
## Sponsoring
## Contributing
We ❤️ pull requests, and we’re continually working hard to make it as easy as possible for developers to contribute.
Thank you for your contribution to WebhookX!
[](https://github.com/webhookx-io/webhookx/graphs/contributors)
[](https://api.star-history.com/svg?repos=webhookx-io/webhookx&type=Date)
## License
```
Copyright 2024 WebhookX
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```