mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code
netbox-community-netbox/docs/models/extras/webhook.md
jeremystretch a7b78565a1 Split webhooks documentation
2022-08-11 11:55:45 -04:00

2.4 KiB
Raw Blame History

Webhooks

A webhook is a mechanism for conveying to some external system a change that took place in NetBox. For example, you may want to notify a monitoring system whenever the status of a device is updated in NetBox. This can be done by creating a webhook for the device model in NetBox and identifying the webhook receiver. When NetBox detects a change to a device, an HTTP request containing the details of the change and who made it be sent to the specified receiver. Webhooks are managed under Logging > Webhooks.

Model Fields

  • Name - A unique name for the webhook. The name is not included with outbound messages.
  • Object type(s) - The type or types of NetBox object that will trigger the webhook.
  • Enabled - If unchecked, the webhook will be inactive.
  • Events - A webhook may trigger on any combination of create, update, and delete events. At least one event type must be selected.
  • HTTP method - The type of HTTP request to send. Options include GET, POST, PUT, PATCH, and DELETE.
  • URL - The fully-qualified URL of the request to be sent. This may specify a destination port number if needed. Jinja2 templating is supported for this field.
  • HTTP content type - The value of the request's Content-Type header. (Defaults to application/json)
  • Additional headers - Any additional headers to include with the request (optional). Add one header per line in the format Name: Value. Jinja2 templating is supported for this field (see below).
  • Body template - The content of the request being sent (optional). Jinja2 templating is supported for this field (see below). If blank, NetBox will populate the request body with a raw dump of the webhook context. (If the HTTP cotent type is set to application/json, this will be formatted as a JSON object.)
  • Secret - A secret string used to prove authenticity of the request (optional). 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.
  • Conditions - An optional set of conditions evaluated to determine whether the webhook fires for a given object.
  • SSL verification - Uncheck this option to disable validation of the receiver's SSL certificate. (Disable with caution!)
  • CA file path - The file path to a particular certificate authority (CA) file to use when validating the receiver's SSL certificate (optional).