Skip to content

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

@jeremystretch

Description

@jeremystretch

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

Metadata

Metadata

Assignees

Labels

complexity: lowRequires minimal effort to implementstatus: acceptedThis issue has been accepted for implementationtype: featureIntroduction of new functionality to the application

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions