starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Support for supplying additional HTTP headers on webhooks #2821

New Issue
Closed
opened 2025-12-29 18:22:28 +01:00 by adam · 3 comments
adam commented 2025-12-29 18:22:28 +01:00
Owner
Copy Link

Originally created by @ajknv on GitHub (Aug 22, 2019).

Environment

  • Python version: 3.6.8
  • NetBox version: 2.6.2

Proposed Functionality

Add ability to specify additional HTTP headers to webhook post requests.

Use Case

To improve security, I would like the endpoint that my webhook is calling to at least be secured by an API key. In order to do this, I need to be able to include an authorization header that provides the key, which is not currently possible.

Database Changes

Something might be needed to store the additional header name/value pairs associated with a webhook?

External Dependencies

None

Originally created by @ajknv on GitHub (Aug 22, 2019). # Environment * Python version: 3.6.8 * NetBox version: 2.6.2 ### Proposed Functionality Add ability to specify additional HTTP headers to webhook post requests. ### Use Case To improve security, I would like the endpoint that my webhook is calling to at least be secured by an API key. In order to do this, I need to be able to include an authorization header that provides the key, which is not currently possible. ### Database Changes Something might be needed to store the additional header name/value pairs associated with a webhook? ### External Dependencies None
adam added the status: acceptedtype: feature labels 2025-12-29 18:22:28 +01:00
adam closed this issue 2025-12-29 18:22:28 +01:00
adam commented 2025-12-29 18:22:28 +01:00
Author
Owner
Copy Link

@DanSheps commented on GitHub (Aug 23, 2019):

An optional secret key can be configured for each webhook. This will append a X-Hook-Signature header to the request, consisting of a HMAC (SHA-512) hex digest of the request body using the secret as the key. This digest can be used by the receiver to authenticate the request's content.

Is this insufficient?

@DanSheps commented on GitHub (Aug 23, 2019): > An optional secret key can be configured for each webhook. This will append a X-Hook-Signature header to the request, consisting of a HMAC (SHA-512) hex digest of the request body using the secret as the key. This digest can be used by the receiver to authenticate the request's content. Is this insufficient?
adam commented 2025-12-29 18:22:29 +01:00
Author
Owner
Copy Link

@ajknv commented on GitHub (Aug 23, 2019):

Things like scopes of authorization, quotas/throttling, and so forth can be associated with an API key, so the HMAC signature alone is an incomplete solution.

@ajknv commented on GitHub (Aug 23, 2019): Things like scopes of authorization, quotas/throttling, and so forth can be associated with an API key, so the HMAC signature alone is an incomplete solution.
adam commented 2025-12-29 18:22:29 +01:00
Author
Owner
Copy Link

@marcin-jedynski commented on GitHub (Oct 3, 2019):

There's a plenty of APIs out there, quite often each of them has a different approach on request authentication. We could largely benefit from the possibility of setting custom headers on Netbox webhooks. This way integrating Netbox with any API would become super easy.

For example right now I am working on Netbox-> StackStorm-> Chef pipeline to use Netbox as GUI interface to our DHCP server.
Sadly the StackStorm does not support HMAC approach of Netbox for request authentication, thus I am forced to use dirty workarounds.

@marcin-jedynski commented on GitHub (Oct 3, 2019): There's a plenty of APIs out there, quite often each of them has a different approach on request authentication. We could largely benefit from the possibility of setting custom headers on Netbox webhooks. This way integrating Netbox with any API would become super easy. For example right now I am working on Netbox-> StackStorm-> Chef pipeline to use Netbox as GUI interface to our DHCP server. Sadly the StackStorm does not support HMAC approach of Netbox for request authentication, thus I am forced to use dirty workarounds.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: feature
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#2821
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?