Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fabianlindfors/sockethook
A Webhook-to-WebSocket proxy in Go
https://github.com/fabianlindfors/sockethook
Last synced: 2 months ago
JSON representation
A Webhook-to-WebSocket proxy in Go
- Host: GitHub
- URL: https://github.com/fabianlindfors/sockethook
- Owner: fabianlindfors
- License: mit
- Created: 2018-06-14T18:41:10.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-11-12T21:24:33.000Z (about 5 years ago)
- Last Synced: 2024-10-31T21:35:12.767Z (2 months ago)
- Language: Go
- Homepage:
- Size: 870 KB
- Stars: 36
- Watchers: 3
- Forks: 23
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sockethook
[](https://heroku.com/deploy)
Sockethook is a Webhook-to-WebSocket proxy written in Go. It's designed for building real-time applications around third-party APIs which provide Webhooks. Sockethook could for example be used to create a live feed of [Github](https://developer.github.com/webhooks/) deployments or a real-time view of [Shopify](https://help.shopify.com/api/reference/events/webhook) orders.
## Usage
Sockethook is written in Go and can be installed by running
`$ go get github.com/fabianlindfors/sockethook`
The tool is started with
```
$ sockethook
INFO[0000] Sockethook is ready and listening at port 1234 ✅
```
Sockethook is now ready to start receiving Webhooks! WebSockets can be connected through `/socket` followed by the endpoint to which you want to subscribe, for example: `/socket/order/created`. Any Webhook requests sent to `/hook/order/created` will now be broadcast to all subscribers listening to the specific endpoint.
The broadcasted message will be JSON encoded and contain information about the Webhook request. The following is an example message from a Shopify Webhook:
```javascript
{
"headers": {
"Accept": "*\/*",
"Accept-Encoding": "gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
"Connection": "close",
"Content-Length": "4264",
"Content-Type": "application\/json",
"User-Agent": "Ruby",
"X-Forwarded-For": "35.231.14.37",
"X-Forwarded-Proto": "https",
"X-Shopify-Hmac-Sha256": "wa5ZVAJPjbtr4Oj8xVnt\/jLWwfD9JdGFcdrjY4VgORQ=",
"X-Shopify-Order-Id": "820982911946154508",
"X-Shopify-Shop-Domain": "fabianlindfors.myshopify.com",
"X-Shopify-Test": "true",
"X-Shopify-Topic": "orders\/create"
},
"endpoint": "\/order\/created",
"data": {
"app_id": null,
"billing_address": {
"address1": "123 Billing Street",
"address2": null,
"city": "Billtown",
"company": "My Company",
"country": "United States",
"country_code": "US",
"first_name": "Bob",
"last_name": "Biller",
"latitude": null,
"longitude": null,
"name": "Bob Biller",
"phone": "555-555-BILL",
"province": "Kentucky",
"province_code": "KY",
"zip": "K2P0B0"
}
...
}
}
```
If the request content type is JSON then the `data` field will contain the JSON body. Otherwise `data` will be a string of the body.
## Command-line options
Two possible options can be passed to Sockethook, `--port` and `--address`. `--port` specifies which port at which to listen (default is 1234) and `--address` sets a specific address to bind to.
```
$ sockethook --port 8000
$ sockethook --address 127.0.0.1
```
## Authentication
Sockethook doesn't include any authentication meaning all endpoints and sockets are publicly available by default. The recommended way to add authentication is to use a reverse proxy or similar, which lends a lot of flexibility. Examples include [nginx](https://www.nginx.com), [Caddy](https://caddyserver.com), and [Traefik](https://traefik.io).
## License
Sockethook is licensed under [MIT](https://github.com/fabianlindfors/sockethook/blob/master/LICENSE).