Releasability:
Reliability:
Security:
Maintainability:
Other:
A simple & lightweight service implemented in go to add webhooks in your application. This service is intended to fire webhooks on different events that are registered.
- Event: A simple event string (eg. post.created)
- Webhook: Webhook registration object. It contains information about events, url (to which webhook will be fired), tags (key value list to filter webhooks)
- Need to install nats.io for queuing service.
- Needs to install postgres database.
- On publishing event to nats.io server, huks service will subscribe to all events added in db and fire webhooks accordingly.
- One can add multiple events, the naming convention of events is based on your application usage.
- Every request takes "X-User" header and to keep track of user who created resources (webhook, event etc.).
- Whenever a webhook is fired its response, tags, etc are logged in webhook_logs.
DATABASE_HOST=postgres
DATABASE_USER=postgres
DATABASE_PASSWORD=postgres
DATABASE_NAME=hukz
DATABASE_PORT=5432
DATABASE_SSL_MODE=disable
NATS_URL=nats://nats:4222
NATS_USER_NAME=natsuser
NATS_USER_PASSWORD=natspassword
QUEUE_GROUP=dega
MODE=development
- Config file should be stored in project root folder with name config (ext can be yml, json, env)
- Environment variables can also be set for configuration parameters with
HUKZ_prefix to above variables.
Create event in tag.created in hukz service and register webhook with tag app:example. Now in the publisher server application can send tag.created event to NATS, whenever a tag is created as follows:
if err = util.NC.Publish("tag.created", result); err != nil {
log.Fatal(err)
}Hukz service will handle firing webhooks to the URLs which are registered to tag.created event. Also, you can get logs of all webhooks fired on /webhooks/logs endpoint.
All events, webhooks and logs can be filtered by tags field. Multiple tag query params can be passed with key:value syntax to get entities which has given tags.