Enable plugins to register custom event types #16886
Assignees
Labels
complexity: medium
Requires a substantial but not unusual amount of effort to implement
status: accepted
This issue has been accepted for implementation
topic: plugins
Relates to the plugins framework
type: feature
Introduction of new functionality to the application
Milestone
Comments
jeremystretch
added
status: accepted
jeremystretch
added a commit
that referenced
this issue
Jul 22, 2024
* Initial work on #16886 * Restore GraphQL filter * Remove namespace * Add Event documentation * Use MultipleChoiceField for event_types * Fix event_types field class on EventRuleImportForm * Fix tests * Simplify event queue handling logic * Misc cleanup
jeremystretch
added a commit
that referenced
this issue
Jul 31, 2024
jeremystretch
added a commit
that referenced
this issue
Jul 31, 2024
Merged
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
NetBox version
v4.0.7
Feature type
New functionality
Proposed functionality
Event rules can be defined to automatically take a certain action (i.e. execute a custom script or generate an outbound webhook) in response to particular events in NetBox. Five event types are currently defined:
This FR proposes enabling NetBox plugin to register their own custom event types, and extending the EventRule model to allow association with these dynamically-registered types.
Some of the initial work toward this functionality has already been completed under #15621.
Use case
As an example, a plugin which tracks network device configurations might introduce a "Configuration changed" event. More generally, this change will also allow more flexibility in defining new event types internally.
Database changes
The set of boolean
type_*fields which currently exist on the EventRule model will likely need to be changed to an array of event type names (to accommodate unknown future event types).External dependencies
None
The text was updated successfully, but these errors were encountered: