Closes #21489: Correct webhook context variable names and event type values #203

New Issue

MrUnknownDE · 2026-04-05T16:22:58+02:00

MrUnknownDE commented

2026-04-05 16:22:58 +02:00

Originally created by @pheus on 3/6/2026

Fixes: #21489

The webhook documentation had a few inaccuracies that could trip up anyone trying to write Jinja2 templates against the webhook payload.

Specifically, the context variable reference listed model instead of the actual object_type field, and event type values were documented as create, update, and delete. NetBox actually emits created, updated, and deleted. Small difference, but it matters when you're pattern-matching against the event variable in a template.

The example JSON payload has also been refreshed to reflect what the REST API actually returns today, including newer fields such as display and display_url that were missing from the previous example.

*Originally created by @pheus on 3/6/2026* ### Fixes: #21489 The webhook documentation had a few inaccuracies that could trip up anyone trying to write Jinja2 templates against the webhook payload. Specifically, the context variable reference listed `model` instead of the actual `object_type` field, and event type values were documented as `create`, `update`, and `delete`. NetBox actually emits `created`, `updated`, and `deleted`. Small difference, but it matters when you're pattern-matching against the `event` variable in a template. The example JSON payload has also been refreshed to reflect what the REST API actually returns today, including newer fields such as `display` and `display_url` that were missing from the previous example.

MrUnknownDE closed this issue

2026-04-05 16:22:58 +02:00

Sign in to join this conversation.

Branches Tags

main

21455-sql-indexes-audit

21357-register-model-actions

feature

20924-plugin-ui-components

21766-improve-test-coverage-for-sortable-table-columns

21157-export-template-public-models

21025-pre-render-config-contexts

21364-swagger

feature-ip-prefix-link

20911-dropdown-3

fix_module_substitution

21160-filterset

20911-dropdown-2

20044-elevation-stuck-lightmode

7604-filter-modifiers-v3

20660-script-load

19724-graphql

14884-script

19720-macaddress-interface-generic-relation

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

No Label

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#203