https://github.com/cdevents/webhook-adapter
https://github.com/cdevents/webhook-adapter
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cdevents/webhook-adapter
- Owner: cdevents
- License: apache-2.0
- Created: 2024-02-20T17:21:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-19T20:33:46.000Z (over 2 years ago)
- Last Synced: 2024-07-22T13:42:02.384Z (almost 2 years ago)
- Language: Go
- Size: 19.5 KB
- Stars: 0
- Watchers: 6
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CDEvents Webhook Adapter
A CDEvents Webhook Adapter can receive events via Webhooks and translate them into CDEvents,
with the help of various translators which supports publishing events via Webhooks.
The translated CDEvents can be sent to configured `messageBroker` URL
This adapter provides client and server implementation over an RPC connection and exposes an interface for plugin implementation,
````go
// EventTranslator is the interface that we're exposing as a plugin.
type EventTranslator interface {
TranslateEvent(event string, headers http.Header) (string, error)
}
````
Various translators can be developed as plugins by implementing this interface method and serve using Hashicorp's [go-plugin](https://github.com/hashicorp/go-plugin/?tab=readme-ov-file#usage)
## Translator's configuration
Once the plugin implemented [translator-plugins.yaml](./translator-plugins.yaml) needs an update with the details of Plugin name, pluginURL and messageBroker
````yaml
translator:
path: "./plugins"
plugins:
- name: ""
pluginURL: ""
messageBroker: ""
````
`DOWNLOAD_PLUGIN` is an environment variable that can be set to `true` or `false` to download the plugin's binary from the translator's `pluginURL` when launching this adapter. Alternatively, the plugin's binary can also be downloaded manually and placed under the `./plugins` directory (create it if it does not exist).
## Plugins implemented using this adapter
| Plugin Name | Plugin Repo |
| :------------ |:-------------------|
| gerrit-translator-cdevents| https://github.com/cdevents/gerrit-translator |
| jira-translator-cdevents | https://github.com/cdevents/jira-translator |