Include complete representation of object type in outbound webhook payload #11449

Closed
opened 2025-12-29 21:45:23 +01:00 by adam · 1 comment
Owner

Originally created by @jeremystretch on GitHub (Aug 6, 2025).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v4.3.5

Feature type

New functionality

Proposed functionality

Add new object_type and object_id fields to the default JSON payload of outbound webhooks:

{
    "event": "updated",
    "timestamp": "2025-08-05T14:24:22.300153+00:00",
    "object_type": "dcim.site",
    "object_id": 123,
    "model": "site",
    "username": "admin",
    ...
}

Note: This is not a breaking change, as the currently model field will be retained to ensure backward compatibility.

Use case

Currently, only the bare model name (e.g. "site") is included. This is ambiguous and represents an opportunity for naming collisions. Additionally, providing the object ID at the JSON data root simplifies the process of extracting the data, as it obviates the need to also parse the data object.

Database changes

N/A

External dependencies

N/A

Originally created by @jeremystretch on GitHub (Aug 6, 2025). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v4.3.5 ### Feature type New functionality ### Proposed functionality Add new `object_type` and `object_id` fields to the default JSON payload of outbound webhooks: ```json { "event": "updated", "timestamp": "2025-08-05T14:24:22.300153+00:00", "object_type": "dcim.site", "object_id": 123, "model": "site", "username": "admin", ... } ``` Note: This is not a breaking change, as the currently `model` field will be retained to ensure backward compatibility. ### Use case Currently, only the bare model name (e.g. `"site"`) is included. This is ambiguous and represents an opportunity for naming collisions. Additionally, providing the object ID at the JSON data root simplifies the process of extracting the data, as it obviates the need to also parse the `data` object. ### Database changes N/A ### External dependencies N/A
adam added the status: acceptedtype: featurecomplexity: low labels 2025-12-29 21:45:23 +01:00
adam closed this issue 2025-12-29 21:45:23 +01:00
Author
Owner

@jeremystretch commented on GitHub (Aug 6, 2025):

Blocked by FR #20003

@jeremystretch commented on GitHub (Aug 6, 2025): Blocked by FR #20003
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#11449