netbox-plugin-webhook-receiver 0.5.0

NetBox Webhook is a plugin for managing webhook receivers in NetBox.

NetBox Webhook Receiver

NetBox Webhook Receiver is a NetBox plugin for managing webhook receiver endpoints and executing assigned actions.

This plugin aims mainly to streamline the deployment process of scripts and export templates to Netbox by triggering the synchronisation of its Data Sources through incoming webhooks. Adding the receiver capability to Netbox opens other possible use cases, which might be worth exploring further. One example could be running Netbox Scripts triggered by remote events where it is not easy to execute a direct API call.

Features

• Per endpoint authentication (signature validation or custom header) on receiving webhooks
• Webhook url enriched with automaticaly generated uuid value for additional security
• Dedicated view to configure each webhook receiver url
• Logical grouping of the receivers
• Optionally store incoming webhook payload
• Custom actions execution on successfully receving authenticated webhook message. Currently only one action available: Synchronize Netbox git 'Data Source'
• Use of standard Netbox jobs to queue webhook actions in the workers.
• Additional actions to be implemented
• Plugin configuration parameters

Requirements

• NetBox 4.1 or higher
• Python 3.10 or higher

Installation & Configuration

For general knowledge about netbox plugin installation please refer to the official guide: Using Plugins - NetBox Documentation

Install NetBox Webhook Receiver:

$ source /opt/netbox/venv/bin/activate
(venv) $ pip install netbox-plugin-webhook-receiver

To register this plugin in NetBox, add netbox_webhook_receiver to the config file. ~/netbox/configuration.py

PLUGINS = [
    "netbox_webhook_receiver",
]

Please remember that this plugin introduces new database models, therefore you must run the provided database schema migrations:

$ source /opt/netbox/venv/bin/activate
(venv) $ cd /opt/netbox/netbox/
(venv) $ python3 manage.py migrate

Screenshots