# generic-event-plugin

**Repository Path**: mamh-java/generic-event-plugin

## Basic Information

- **Project Name**: generic-event-plugin
- **Description**: https://github.com/mamh-java/generic-event-plugin
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-05-14
- **Last Updated**: 2025-03-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Generic Event Plugin

## Introduction

The Generic Event Plugin built for Jenkins is mainly to solve the interaction problem between the third-party system and
Jenkins.

By using the plugin, the third-party system can receive the events it is interested in more quickly and respond quickly.

At present, our event body mainly refers to CloudEvents, and CloudEvents specification may be supported in the future.
We look forward to more people to push this goal.

## Getting Started

You can configure the event receiver in system management:

```txt
Event Dispatcher

Event Receiver
,-----------------------------------------------.
|http://localhost:8000/v1alpha1/webhooks/jenkins|
`-----------------------------------------------'
The receiver that can receive the event fired by system.
```

## Events Documentation

After the event receiver is configured, we can easily receive events from Jenkins. The following is the detailed
document of the corresponding event:

- [Run Event](docs/run.md)
- [Job Event](docs/job.md)

## TODOs

- [ ] Send events asynchronously
- [ ] Support custom filter to filter events
- [ ] Collect more events

## Contributing

Please refer to [Developer Guide](docs/developer.md).

## LICENSE

Licensed under Apache 2.0, see [LICENSE](LICENSE)