Enable plugins to register custom event types #9974

New Issue

adam · 2025-12-29T21:25:06+01:00

adam commented

2025-12-29 21:25:06 +01:00

Originally created by @jeremystretch on GitHub (Jul 11, 2024).

Originally assigned to: @jeremystretch on GitHub.

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:

Object created
Object updated
Object deleted
Job started
Job completed

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

Originally created by @jeremystretch on GitHub (Jul 11, 2024). Originally assigned to: @jeremystretch on GitHub. ### 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: - Object created - Object updated - Object deleted - Job started - Job completed 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

adam added the status: accepted type: feature topic: plugins complexity: medium topic: event rules labels 2025-12-29 21:25:06 +01:00

adam closed this issue

2025-12-29 21:25:07 +01:00

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#9974