Allow plugin models to be used as CustomField object if they don't provide webhooks #8628

New Issue

adam · 2025-12-29T20:39:05+01:00

adam commented

2025-12-29 20:39:05 +01:00

Originally created by @rixx on GitHub (Sep 15, 2023).

NetBox version

master

Feature type

Data model extension

Proposed functionality

Currently, only plugin models that provide the webhooks feature set are selectable for related custom fields. (There's already a TODO note there calling this out.) I'd like to mark my plugin's models as suitable for custom fields even without providing webhook integration.

Use case

I usually subclass NetBoxModel in my plugins. However, in this plugin, I'm shipping multiple plugins in a single package. This means that the import path to a model may be my_bundle.appname.models.MyModel, whereas its app_name is just appname.MyModel. As the webhooks integration attempts a dynamic import and fails if it cannot import appname.serializers.MyModelSerializer, I chose to exclude the webhook integration – however, I'd still like the plugin model to be available for custom fields.

Database changes

External dependencies

Originally created by @rixx on GitHub (Sep 15, 2023). ### NetBox version master ### Feature type Data model extension ### Proposed functionality Currently, only plugin models that provide the `webhooks` feature set [are selectable](https://github.com/netbox-community/netbox/blob/develop/netbox/extras/forms/model_forms.py#L53) for related custom fields. (There's already a `TODO` note there calling this out.) I'd like to mark my plugin's models as suitable for custom fields even without providing webhook integration. ### Use case I usually subclass `NetBoxModel` in my plugins. However, in this plugin, I'm shipping multiple plugins in a single package. This means that the import path to a model may be `my_bundle.appname.models.MyModel`, whereas its `app_name` is just `appname.MyModel`. As the webhooks integration attempts a dynamic import and fails if it cannot import `appname.serializers.MyModelSerializer`, I chose to exclude the webhook integration – however, I'd still like the plugin model to be available for custom fields. ### Database changes - ### External dependencies -

adam added the type: feature label 2025-12-29 20:39:05 +01:00

adam closed this issue

2025-12-29 20:39:05 +01:00

adam commented

2025-12-29 20:39:05 +01:00

@jeremystretch commented on GitHub (Sep 15, 2023):

This is one of the symptoms that would be corrected under #13427, and is currently planned for the v4.0 release. I'm going to close this out as it will be addressed by that work, but thank you for calling it out explicitly.

@jeremystretch commented on GitHub (Sep 15, 2023): This is one of the symptoms that would be corrected under #13427, and is currently planned for the v4.0 release. I'm going to close this out as it will be addressed by that work, but thank you for calling it out explicitly.

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#8628