Feature Request: Editable Webhook POST format #2180

New Issue

adam · 2025-12-29T17:23:04+01:00

adam commented

2025-12-29 17:23:04 +01:00

Originally created by @berahtlv on GitHub (Dec 7, 2018).

Environment

Python version: 3.5.4 ->
NetBox version: 2.5.1 ->

Proposed Functionality

Editable Webhook POST format to ensure compatibility with different REST APIs. At the moment direct API to API calls are not possible because of JSON keys incompatibility.

Use Case

Netbox object change triggers defined webhook which sends POST request to some API for configuration synchronization or informative message generation.

Database Changes

Minor additions.

External Dependencies

No additional.

Originally created by @berahtlv on GitHub (Dec 7, 2018). ### Environment * Python version: 3.5.4 -> * NetBox version: 2.5.1 -> ### Proposed Functionality Editable Webhook POST format to ensure compatibility with different REST APIs. At the moment direct API to API calls are not possible because of JSON keys incompatibility. ### Use Case Netbox object change triggers defined webhook which sends POST request to some API for configuration synchronization or informative message generation. ### Database Changes Minor additions. ### External Dependencies No additional.

adam closed this issue

2025-12-29 17:23:04 +01:00

adam commented

2025-12-29 17:23:04 +01:00

@jeremystretch commented on GitHub (Dec 7, 2018):

Webhooks are not intended to be exported directly to another API. Some intermediary processing will be needed to adapt the data, and this is well outside the scope of NetBox. We just send as much information as we have with the request.

@jeremystretch commented on GitHub (Dec 7, 2018): Webhooks are not intended to be exported directly to another API. Some intermediary processing will be needed to adapt the data, and this is well outside the scope of NetBox. We just send as much information as we have with the request.

adam commented

2025-12-29 17:23:05 +01:00

@berahtlv commented on GitHub (Dec 13, 2018):

... Some intermediary processing will be needed to adapt the data, and this is well outside the scope of NetBox. ...

If feature will be requested as PR you accept it?

Idea is to add to admin/webhook page check like 'API to API' which will activate raw mapping template area, something like Contexts area, so users by themselves can edit output format. Output definition can have some templating syntax or JSON which defines mapping of the keys.

Addition to netbox/netbox/extras/webhooks_worker.py and frontend will be needed.
Can look something like that.

Mappings:

from string import Template
key_map = {'default':Template('{"text":"$r_model is $r_event at $r_timestamp"}'),
           'prefix':Template('{"text":"$r_model $prefix is $r_event at $r_timestamp"}'),
}

Renaming to flatten sent object dictionary:

payload = json.loads(params.pop('data'))
obj_event = {'r_model':payload['model'].title(),
            'r_event':payload['event'],
            'r_timestamp':payload['timestamp']
}

Mapping of the data according to template:

payload['data'].update(**obj_event)
params['data'] = key_map.get(payload['model'], key_map['default']).substitute(**payload['data'])

@berahtlv commented on GitHub (Dec 13, 2018): > ... Some intermediary processing will be needed to adapt the data, and this is well outside the scope of NetBox. ... If feature will be requested as PR you accept it? Idea is to add to admin/webhook page check like 'API to API' which will activate raw mapping template area, something like Contexts area, so users by themselves can edit output format. Output definition can have some templating syntax or JSON which defines mapping of the keys. Addition to netbox/netbox/extras/webhooks_worker.py and frontend will be needed. Can look something like that. Mappings: ``` from string import Template key_map = {'default':Template('{"text":"$r_model is $r_event at $r_timestamp"}'), 'prefix':Template('{"text":"$r_model $prefix is $r_event at $r_timestamp"}'), } ``` Renaming to flatten sent object dictionary: ``` payload = json.loads(params.pop('data')) obj_event = {'r_model':payload['model'].title(), 'r_event':payload['event'], 'r_timestamp':payload['timestamp'] } ``` Mapping of the data according to template: ``` payload['data'].update(**obj_event) params['data'] = key_map.get(payload['model'], key_map['default']).substitute(**payload['data']) ```

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