nautobot 2.4.4__py3-none-any.whl → 2.4.6__py3-none-any.whl

nautobot/project-static/docs/user-guide/platform-functionality/webhook.html

@@ -5851,9 +5851,9 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#configuration" class="md-nav__link">
+  <a href="#configuring-a-webhook" class="md-nav__link">
     <span class="md-ellipsis">
-      Configuration
+      Configuring a Webhook
     </span>
   </a>
   
@@ -5870,26 +5870,26 @@
       <ul class="md-nav__list">
         
           <li class="md-nav__item">
-  <a href="#available-context" class="md-nav__link">
+  <a href="#available-context-variables" class="md-nav__link">
     <span class="md-ellipsis">
-      Available Context
+      Available Context Variables
     </span>
   </a>
   
 </li>
         
-          <li class="md-nav__item">
+      </ul>
+    </nav>
+  
+</li>
+      
+        <li class="md-nav__item">
   <a href="#default-request-body" class="md-nav__link">
     <span class="md-ellipsis">
       Default Request Body
     </span>
   </a>
   
-</li>
-        
-      </ul>
-    </nav>
-  
 </li>
       
         <li class="md-nav__item">
@@ -5902,9 +5902,9 @@
 </li>
       
         <li class="md-nav__item">
-  <a href="#troubleshooting" class="md-nav__link">
+  <a href="#troubleshooting-webhooks" class="md-nav__link">
     <span class="md-ellipsis">
-      Troubleshooting
+      Troubleshooting Webhooks
     </span>
   </a>
   
@@ -9200,9 +9200,9 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#configuration" class="md-nav__link">
+  <a href="#configuring-a-webhook" class="md-nav__link">
     <span class="md-ellipsis">
-      Configuration
+      Configuring a Webhook
     </span>
   </a>
   
@@ -9219,26 +9219,26 @@
       <ul class="md-nav__list">
         
           <li class="md-nav__item">
-  <a href="#available-context" class="md-nav__link">
+  <a href="#available-context-variables" class="md-nav__link">
     <span class="md-ellipsis">
-      Available Context
+      Available Context Variables
     </span>
   </a>
   
 </li>
         
-          <li class="md-nav__item">
+      </ul>
+    </nav>
+  
+</li>
+      
+        <li class="md-nav__item">
   <a href="#default-request-body" class="md-nav__link">
     <span class="md-ellipsis">
       Default Request Body
     </span>
   </a>
   
-</li>
-        
-      </ul>
-    </nav>
-  
 </li>
       
         <li class="md-nav__item">
@@ -9251,9 +9251,9 @@
 </li>
       
         <li class="md-nav__item">
-  <a href="#troubleshooting" class="md-nav__link">
+  <a href="#troubleshooting-webhooks" class="md-nav__link">
     <span class="md-ellipsis">
-      Troubleshooting
+      Troubleshooting Webhooks
     </span>
   </a>
   
@@ -9278,114 +9278,199 @@
 
 
 <h1 id="webhooks">Webhooks<a class="headerlink" href="#webhooks" title="Permanent link">&para;</a></h1>
-<p>A webhook is a mechanism for conveying to some external system a change that took place in Nautobot. For example, you may want to notify a monitoring system whenever the status of a device is updated in Nautobot. This can be done by creating a webhook for the device model in Nautobot and identifying the webhook receiver. When Nautobot 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 configured in the web UI under Extensibility &gt; Webhooks.</p>
-<h2 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">&para;</a></h2>
-<ul>
-<li><strong>Name</strong> - A unique name for the webhook. The name is not included with outbound messages.</li>
-<li><strong>Object type(s)</strong> - The type or types of Nautobot object that will trigger the webhook.</li>
-<li><strong>Enabled</strong> - If unchecked, the webhook will be inactive.</li>
-<li><strong>Events</strong> - A webhook may trigger on any combination of create, update, and delete events. At least one event type must be selected.</li>
-<li><strong>HTTP method</strong> - The type of HTTP request to send. Options include <code>GET</code>, <code>POST</code>, <code>PUT</code>, <code>PATCH</code>, and <code>DELETE</code>.</li>
-<li><strong>URL</strong> - The fuly-qualified URL of the request to be sent. This may specify a destination port number if needed.</li>
-<li><strong>HTTP content type</strong> - The value of the request's <code>Content-Type</code> header. (Defaults to <code>application/json</code>)</li>
-<li><strong>Additional headers</strong> - Any additional headers to include with the request (optional). Add one header per line in the format <code>Name: Value</code>. Jinja2 templating is supported for this field (see below).</li>
-<li><strong>Body template</strong> - The content of the request being sent (optional). Jinja2 templating is supported for this field (see below). If blank, Nautobot will populate the request body with a raw dump of the webhook context. (If the HTTP content-type is set to <code>application/json</code>, this will be formatted as a JSON object.)</li>
-<li><strong>Secret</strong> - A secret string used to prove authenticity of the request (optional). This will append a <code>X-Hook-Signature</code> header to the request, consisting of a HMAC (SHA-512) hex digest of the request body using the secret as the key.</li>
-<li><strong>SSL verification</strong> - Uncheck this option to disable validation of the receiver's SSL certificate. (Disable with caution!)</li>
-<li><strong>CA file path</strong> - The file path to a particular certificate authority (CA) file to use when validating the receiver's SSL certificate (optional).</li>
-</ul>
+<p>A webhook is a mechanism for notifying an external system when a change occurs in Nautobot. For example, you might want to alert a monitoring tool whenever a device's status is updated. This can be achieved by creating a webhook for the device model and specifying a receiver URL. When Nautobot detects a change, it sends an HTTP request with details about the event and the user who triggered it.</p>
+<p>Webhooks are managed via the web UI under <strong>Extensibility &gt; Webhooks</strong>.</p>
+<h2 id="configuring-a-webhook">Configuring a Webhook<a class="headerlink" href="#configuring-a-webhook" title="Permanent link">&para;</a></h2>
+<p>When setting up a webhook, you need to define the following parameters:</p>
+<table>
+<thead>
+<tr>
+<th>Parameter</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><strong>Name</strong></td>
+<td>A unique name for the webhook (not included in outgoing messages).</td>
+</tr>
+<tr>
+<td><strong>Object type(s)</strong></td>
+<td>The type(s) of Nautobot objects that trigger the webhook.</td>
+</tr>
+<tr>
+<td><strong>Enabled</strong></td>
+<td>Indicates whether the webhook is active.</td>
+</tr>
+<tr>
+<td><strong>Events</strong></td>
+<td>Select one or more events: <code>create</code>, <code>update</code>, or <code>delete</code>.</td>
+</tr>
+<tr>
+<td><strong>HTTP method</strong></td>
+<td>The type of HTTP request (<code>GET</code>, <code>POST</code>, <code>PUT</code>, <code>PATCH</code>, <code>DELETE</code>).</td>
+</tr>
+<tr>
+<td><strong>URL</strong></td>
+<td>The fully qualified URL of the receiver. You can specify a port if needed.</td>
+</tr>
+<tr>
+<td><strong>HTTP content type</strong></td>
+<td>Sets the <code>Content-Type</code> header (default: <code>application/json</code>).</td>
+</tr>
+<tr>
+<td><strong>Additional headers</strong></td>
+<td>Custom headers, one per line (<code>Name: Value</code>). Supports Jinja2 templating.</td>
+</tr>
+<tr>
+<td><strong>Body template</strong></td>
+<td>Custom request body. Supports Jinja2 templating. If empty, Nautobot sends the default payload.</td>
+</tr>
+<tr>
+<td><strong>Secret</strong></td>
+<td>A secret string used for HMAC (SHA-512) authentication. The webhook request includes an <code>X-Hook-Signature</code> header.</td>
+</tr>
+<tr>
+<td><strong>SSL verification</strong></td>
+<td>If unchecked, Nautobot skips SSL certificate validation (use with caution).</td>
+</tr>
+<tr>
+<td><strong>CA file path</strong></td>
+<td>Specifies a custom CA file for SSL validation.</td>
+</tr>
+</tbody>
+</table>
 <h2 id="jinja2-template-support">Jinja2 Template Support<a class="headerlink" href="#jinja2-template-support" title="Permanent link">&para;</a></h2>
-<p><a href="https://jinja.palletsprojects.com/">Jinja2 templating</a> is supported for the <code>additional_headers</code> and <code>body_template</code> fields. This enables the user to convey object data in the request headers as well as to craft a customized request body. Request content can be crafted to enable the direct interaction with external systems by ensuring the outgoing message is in a format the receiver expects and understands.</p>
-<p>For example, you might create a Nautobot webhook to <a href="https://api.slack.com/messaging/webhooks">trigger a Slack message</a> any time an IP address is created. You can accomplish this using the following configuration:</p>
-<ul>
-<li>Object type: IPAM &gt; IP address</li>
-<li>HTTP method: <code>POST</code></li>
-<li>URL: Slack incoming webhook URL</li>
-<li>HTTP content type: <code>application/json</code></li>
-<li>Body template: <code>{"text": "IP address {{ data['address'] }} was created by {{ username }}!"}</code></li>
-</ul>
-<h3 id="available-context">Available Context<a class="headerlink" href="#available-context" title="Permanent link">&para;</a></h3>
-<p>The following data is available as context for Jinja2 templates:</p>
+<p><a href="https://jinja.palletsprojects.com/">Jinja2 templating</a> is supported for the <code>additional_headers</code> and <code>body_template</code> fields. It allows you to customize headers and request bodies dynamically. This is useful for formatting webhook payloads to match external system expectations.</p>
+<p>Example: Trigger a Slack message when a new IP address is created.</p>
+<p><strong>Webhook Configuration:</strong></p>
 <ul>
-<li><code>event</code> - The type of event which triggered the webhook: created, updated, or deleted.</li>
-<li><code>model</code> - The Nautobot model which triggered the change.</li>
-<li><code>timestamp</code> - The time at which the event occurred (in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> format).</li>
-<li><code>username</code> - The name of the user account associated with the change.</li>
-<li><code>request_id</code> - The unique request ID. This may be used to correlate multiple changes associated with a single request.</li>
-<li><code>data</code> - A serialized representation of the object <em>after</em> the change was made. This is typically equivalent to the model's representation in Nautobot's REST API.</li>
-<li><code>snapshots</code> - snapshots of the serialized object state both before and after the change was made; provided as a dictionary with keys named <code>prechange</code>, <code>postchange</code> and <code>differences</code>.</li>
+<li><strong>Object type</strong>: IPAM &gt; IP address</li>
+<li><strong>HTTP method</strong>: <code>POST</code></li>
+<li><strong>URL</strong>: Slack incoming webhook URL</li>
+<li><strong>HTTP content type</strong>: <code>application/json</code></li>
+<li><strong>Body template</strong>:</li>
 </ul>
-<h3 id="default-request-body">Default Request Body<a class="headerlink" href="#default-request-body" title="Permanent link">&para;</a></h3>
-<p>If no body template is specified, the request body will be populated with a JSON object containing the context data. For example, a newly created Location might appear as follows:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>{
-<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>    &quot;event&quot;: &quot;created&quot;,
-<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>    &quot;timestamp&quot;: &quot;2023-02-14 12:34:56.000000+00:00&quot;,
-<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>    &quot;model&quot;: &quot;location&quot;,
-<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>    &quot;username&quot;: &quot;admin&quot;,
-<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>    &quot;request_id&quot;: &quot;fab0a4fb-52ba-4cb4-9756-4e6a3ac05332&quot;,
-<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a>    &quot;data&quot;: {
-<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a>        &quot;id&quot;: &quot;5e4f9a91-372b-46df-a50a-c26357475bee&quot;,
-<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a>        &quot;display&quot;: &quot;Campus A&quot;,
-<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a>        &quot;url&quot;: &quot;/api/dcim/locations/5e4f9a91-372b-46df-a50a-c26357475bee/&quot;,
-<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a>        &quot;name&quot;: &quot;Campus A&quot;,
-<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a>        &quot;status&quot;: {
-<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a>            &quot;display&quot;: &quot;Active&quot;,
-<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a>            &quot;id&quot;: &quot;363a431c-c784-40b5-8513-758cafd174ad&quot;,
-<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a>            &quot;url&quot;: &quot;/api/extras/statuses/363a431c-c784-40b5-8513-758cafd174ad/&quot;,
-<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a>            &quot;name&quot;: &quot;Active&quot;,
-<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a>            &quot;created&quot;: &quot;2023-02-14T00:00:00Z&quot;,
-<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a>            &quot;last_updated&quot;: &quot;2023-02-14T19:40:13.216150Z&quot;
-<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a>        },
-<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a>        ...
-<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a>    },
-<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a>    &quot;snapshots&quot;: {
-<a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a>        &quot;prechange&quot;: null,
-<a id="__codelineno-0-24" name="__codelineno-0-24" href="#__codelineno-0-24"></a>        &quot;postchange&quot;: {
-<a id="__codelineno-0-25" name="__codelineno-0-25" href="#__codelineno-0-25"></a>            &quot;id&quot;: &quot;5e4f9a91-372b-46df-a50a-c26357475bee&quot;,
-<a id="__codelineno-0-26" name="__codelineno-0-26" href="#__codelineno-0-26"></a>            &quot;asn&quot;: null,
-<a id="__codelineno-0-27" name="__codelineno-0-27" href="#__codelineno-0-27"></a>            &quot;url&quot;: &quot;/api/dcim/locations/5e4f9a91-372b-46df-a50a-c26357475bee/&quot;,
-<a id="__codelineno-0-28" name="__codelineno-0-28" href="#__codelineno-0-28"></a>            &quot;name&quot;: &quot;Campus A&quot;,
-<a id="__codelineno-0-29" name="__codelineno-0-29" href="#__codelineno-0-29"></a>            ...
-<a id="__codelineno-0-30" name="__codelineno-0-30" href="#__codelineno-0-30"></a>        },
-<a id="__codelineno-0-31" name="__codelineno-0-31" href="#__codelineno-0-31"></a>        &quot;differences&quot;: {
-<a id="__codelineno-0-32" name="__codelineno-0-32" href="#__codelineno-0-32"></a>            &quot;removed&quot;: null,
-<a id="__codelineno-0-33" name="__codelineno-0-33" href="#__codelineno-0-33"></a>            &quot;added&quot;: {
-<a id="__codelineno-0-34" name="__codelineno-0-34" href="#__codelineno-0-34"></a>                &quot;id&quot;: &quot;5e4f9a91-372b-46df-a50a-c26357475bee&quot;,
-<a id="__codelineno-0-35" name="__codelineno-0-35" href="#__codelineno-0-35"></a>                &quot;asn&quot;: null,
-<a id="__codelineno-0-36" name="__codelineno-0-36" href="#__codelineno-0-36"></a>                &quot;url&quot;: &quot;/api/dcim/locations/5e4f9a91-372b-46df-a50a-c26357475bee/&quot;,
-<a id="__codelineno-0-37" name="__codelineno-0-37" href="#__codelineno-0-37"></a>                &quot;name&quot;: &quot;Campus A&quot;,
-<a id="__codelineno-0-38" name="__codelineno-0-38" href="#__codelineno-0-38"></a>                ...
-<a id="__codelineno-0-39" name="__codelineno-0-39" href="#__codelineno-0-39"></a>            }
-<a id="__codelineno-0-40" name="__codelineno-0-40" href="#__codelineno-0-40"></a>        }
-<a id="__codelineno-0-41" name="__codelineno-0-41" href="#__codelineno-0-41"></a>    }
-<a id="__codelineno-0-42" name="__codelineno-0-42" href="#__codelineno-0-42"></a>}
+<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="p">{</span><span class="nt">&quot;text&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;IP address {{ data[&#39;address&#39;] }} was created by {{ username }}!&quot;</span><span class="p">}</span>
+</code></pre></div>
+<h3 id="available-context-variables">Available Context Variables<a class="headerlink" href="#available-context-variables" title="Permanent link">&para;</a></h3>
+<table>
+<thead>
+<tr>
+<th>Variable</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>event</code></td>
+<td>The event type (<code>created</code>, <code>updated</code>, <code>deleted</code>).</td>
+</tr>
+<tr>
+<td><code>model</code></td>
+<td>The Nautobot model triggering the event.</td>
+</tr>
+<tr>
+<td><code>timestamp</code></td>
+<td>The event timestamp in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> format.</td>
+</tr>
+<tr>
+<td><code>username</code></td>
+<td>The user who triggered the event.</td>
+</tr>
+<tr>
+<td><code>request_id</code></td>
+<td>A unique request ID for correlation of multiple changes associated with a single request.</td>
+</tr>
+<tr>
+<td><code>data</code></td>
+<td>A serialized representation of the object <em>after</em> the change.</td>
+</tr>
+<tr>
+<td><code>snapshots</code></td>
+<td>Contains <code>prechange</code>, <code>postchange</code>, and <code>differences</code> snapshots.</td>
+</tr>
+</tbody>
+</table>
+<h2 id="default-request-body">Default Request Body<a class="headerlink" href="#default-request-body" title="Permanent link">&para;</a></h2>
+<p>If no body template is provided, Nautobot sends a default JSON payload:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="p">{</span>
+<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w">    </span><span class="nt">&quot;event&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;created&quot;</span><span class="p">,</span>
+<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w">    </span><span class="nt">&quot;timestamp&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2023-02-14T12:34:56.000000+00:00&quot;</span><span class="p">,</span>
+<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w">    </span><span class="nt">&quot;model&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;location&quot;</span><span class="p">,</span>
+<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="w">    </span><span class="nt">&quot;username&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;admin&quot;</span><span class="p">,</span>
+<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="w">    </span><span class="nt">&quot;request_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;fab0a4fb-52ba-4cb4-9756-4e6a3ac05332&quot;</span><span class="p">,</span>
+<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="w">    </span><span class="nt">&quot;data&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
+<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="w">        </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;5e4f9a91-372b-46df-a50a-c26357475bee&quot;</span><span class="p">,</span>
+<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="w">        </span><span class="nt">&quot;display&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Campus A&quot;</span><span class="p">,</span>
+<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="w">        </span><span class="nt">&quot;url&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;/api/dcim/locations/5e4f9a91-372b-46df-a50a-c26357475bee/&quot;</span><span class="p">,</span>
+<a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="w">        </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Campus A&quot;</span><span class="p">,</span>
+<a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a><span class="w">        </span><span class="nt">&quot;status&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
+<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a><span class="w">            </span><span class="nt">&quot;display&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Active&quot;</span><span class="p">,</span>
+<a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a><span class="w">            </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;363a431c-c784-40b5-8513-758cafd174ad&quot;</span><span class="p">,</span>
+<a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a><span class="w">            </span><span class="nt">&quot;url&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;/api/extras/statuses/363a431c-c784-40b5-8513-758cafd174ad/&quot;</span><span class="p">,</span>
+<a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a><span class="w">            </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Active&quot;</span><span class="p">,</span>
+<a id="__codelineno-1-17" name="__codelineno-1-17" href="#__codelineno-1-17"></a><span class="w">            </span><span class="nt">&quot;created&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2023-02-14T00:00:00Z&quot;</span><span class="p">,</span>
+<a id="__codelineno-1-18" name="__codelineno-1-18" href="#__codelineno-1-18"></a><span class="w">            </span><span class="nt">&quot;last_updated&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2023-02-14T19:40:13.216150Z&quot;</span>
+<a id="__codelineno-1-19" name="__codelineno-1-19" href="#__codelineno-1-19"></a><span class="w">        </span><span class="p">},</span>
+<a id="__codelineno-1-20" name="__codelineno-1-20" href="#__codelineno-1-20"></a><span class="w">        </span><span class="err">...</span>
+<a id="__codelineno-1-21" name="__codelineno-1-21" href="#__codelineno-1-21"></a><span class="w">    </span><span class="p">},</span>
+<a id="__codelineno-1-22" name="__codelineno-1-22" href="#__codelineno-1-22"></a><span class="w">    </span><span class="nt">&quot;snapshots&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
+<a id="__codelineno-1-23" name="__codelineno-1-23" href="#__codelineno-1-23"></a><span class="w">        </span><span class="nt">&quot;prechange&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
+<a id="__codelineno-1-24" name="__codelineno-1-24" href="#__codelineno-1-24"></a><span class="w">        </span><span class="nt">&quot;postchange&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
+<a id="__codelineno-1-25" name="__codelineno-1-25" href="#__codelineno-1-25"></a><span class="w">            </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;5e4f9a91-372b-46df-a50a-c26357475bee&quot;</span><span class="p">,</span>
+<a id="__codelineno-1-26" name="__codelineno-1-26" href="#__codelineno-1-26"></a><span class="w">            </span><span class="nt">&quot;asn&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
+<a id="__codelineno-1-27" name="__codelineno-1-27" href="#__codelineno-1-27"></a><span class="w">            </span><span class="nt">&quot;url&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;/api/dcim/locations/5e4f9a91-372b-46df-a50a-c26357475bee/&quot;</span><span class="p">,</span>
+<a id="__codelineno-1-28" name="__codelineno-1-28" href="#__codelineno-1-28"></a><span class="w">            </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Campus A&quot;</span><span class="p">,</span>
+<a id="__codelineno-1-29" name="__codelineno-1-29" href="#__codelineno-1-29"></a><span class="w">            </span><span class="err">...</span>
+<a id="__codelineno-1-30" name="__codelineno-1-30" href="#__codelineno-1-30"></a><span class="w">        </span><span class="p">},</span>
+<a id="__codelineno-1-31" name="__codelineno-1-31" href="#__codelineno-1-31"></a><span class="w">        </span><span class="nt">&quot;differences&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
+<a id="__codelineno-1-32" name="__codelineno-1-32" href="#__codelineno-1-32"></a><span class="w">            </span><span class="nt">&quot;removed&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
+<a id="__codelineno-1-33" name="__codelineno-1-33" href="#__codelineno-1-33"></a><span class="w">            </span><span class="nt">&quot;added&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
+<a id="__codelineno-1-34" name="__codelineno-1-34" href="#__codelineno-1-34"></a><span class="w">                </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;5e4f9a91-372b-46df-a50a-c26357475bee&quot;</span><span class="p">,</span>
+<a id="__codelineno-1-35" name="__codelineno-1-35" href="#__codelineno-1-35"></a><span class="w">                </span><span class="nt">&quot;asn&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
+<a id="__codelineno-1-36" name="__codelineno-1-36" href="#__codelineno-1-36"></a><span class="w">                </span><span class="nt">&quot;url&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;/api/dcim/locations/5e4f9a91-372b-46df-a50a-c26357475bee/&quot;</span><span class="p">,</span>
+<a id="__codelineno-1-37" name="__codelineno-1-37" href="#__codelineno-1-37"></a><span class="w">                </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Campus A&quot;</span><span class="p">,</span>
+<a id="__codelineno-1-38" name="__codelineno-1-38" href="#__codelineno-1-38"></a><span class="w">                </span><span class="err">...</span>
+<a id="__codelineno-1-39" name="__codelineno-1-39" href="#__codelineno-1-39"></a><span class="w">            </span><span class="p">}</span>
+<a id="__codelineno-1-40" name="__codelineno-1-40" href="#__codelineno-1-40"></a><span class="w">        </span><span class="p">}</span>
+<a id="__codelineno-1-41" name="__codelineno-1-41" href="#__codelineno-1-41"></a><span class="w">    </span><span class="p">}</span>
+<a id="__codelineno-1-42" name="__codelineno-1-42" href="#__codelineno-1-42"></a><span class="p">}</span>
 </code></pre></div>
 <h2 id="webhook-processing">Webhook Processing<a class="headerlink" href="#webhook-processing" title="Permanent link">&para;</a></h2>
-<p>When a change is detected, any resulting webhooks are placed into a Redis queue for processing. This allows the user's request to complete without needing to wait for the outgoing webhook(s) to be processed. The webhooks are then extracted from the queue by the <code>celery worker</code> process and HTTP requests are sent to their respective destinations.</p>
-<p>A request is considered successful if the response has a 2XX status code; otherwise, the request is marked as having failed. Failed requests may be retried manually via the admin UI.</p>
-<h2 id="troubleshooting">Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permanent link">&para;</a></h2>
-<p>To assist with verifying that the content of outgoing webhooks is rendered correctly, Nautobot provides a simple HTTP listener that can be run locally to receive and display webhook requests. First, modify the target URL of the desired webhook to <code>http://localhost:9000/</code>. This will instruct Nautobot to send the request to the local server on TCP port 9000. Then, start the webhook receiver service from the Nautobot root directory:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>nautobot-server webhook_receiver
+<p>When Nautobot detects a relevant change, it queues the webhook in Redis. This ensures that webhook processing does not delay the original request. A Celery worker then dequeues and sends the HTTP request to the specified receiver.</p>
+<p>A webhook request is considered successful if the receiver responds with a <code>2XX</code> status code. Failed requests can be retried manually via the admin UI.</p>
+<h2 id="troubleshooting-webhooks">Troubleshooting Webhooks<a class="headerlink" href="#troubleshooting-webhooks" title="Permanent link">&para;</a></h2>
+<p>To inspect outgoing webhooks, you can use a local HTTP listener. Nautobot provides a built-in webhook receiver that logs incoming requests:</p>
+<ol>
+<li>Set the webhook URL to <code>http://localhost:9000/</code>.</li>
+<li>
+<p>Start the webhook receiver:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>nautobot-server<span class="w"> </span>webhook_receiver
 </code></pre></div>
 <p>Example output:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>Listening on port http://localhost:9000. Stop with CONTROL-C.
+<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>Listening<span class="w"> </span>on<span class="w"> </span>port<span class="w"> </span>http://localhost:9000.<span class="w"> </span>Stop<span class="w"> </span>with<span class="w"> </span>CONTROL-C.
 </code></pre></div>
-<p>You can test the receiver itself by sending any HTTP request to it. For example:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>curl -X POST http://localhost:9000 --data &#39;{&quot;foo&quot;: &quot;bar&quot;}&#39;
+</li>
+<li>
+<p>Send a test request:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>curl<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>http://localhost:9000<span class="w"> </span>--data<span class="w"> </span><span class="s1">&#39;{&quot;foo&quot;: &quot;bar&quot;}&#39;</span>
 </code></pre></div>
-<p>The server will print output similar to the following:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>[1] Tue, 07 Apr 2020 17:44:02 GMT 127.0.0.1 &quot;POST / HTTP/1.1&quot; 200 -
-<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>Host: localhost:9000
-<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>User-Agent: curl/7.58.0
-<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a>Accept: */*
-<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a>Content-Length: 14
-<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a>Content-Type: application/x-www-form-urlencoded
-<a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a>
-<a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a>{&quot;foo&quot;: &quot;bar&quot;}
-<a id="__codelineno-4-9" name="__codelineno-4-9" href="#__codelineno-4-9"></a>------------
+<p>The listener will output:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="o">[</span><span class="m">1</span><span class="o">]</span><span class="w"> </span>Tue,<span class="w"> </span><span class="m">07</span><span class="w"> </span>Apr<span class="w"> </span><span class="m">2020</span><span class="w"> </span><span class="m">17</span>:44:02<span class="w"> </span>GMT<span class="w"> </span><span class="m">127</span>.0.0.1<span class="w"> </span><span class="s2">&quot;POST / HTTP/1.1&quot;</span><span class="w"> </span><span class="m">200</span><span class="w"> </span>-
+<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>Host:<span class="w"> </span>localhost:9000
+<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a>Content-Type:<span class="w"> </span>application/json
+<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a>Content-Length:<span class="w"> </span><span class="m">14</span>
+<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a>
+<a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a><span class="o">{</span><span class="s2">&quot;foo&quot;</span>:<span class="w"> </span><span class="s2">&quot;bar&quot;</span><span class="o">}</span>
 </code></pre></div>
-<p>Note that <code>webhook_receiver</code> does not actually <em>do</em> anything with the information received: It merely prints the request headers and body for inspection.</p>
-<p>Now, when the Nautobot webhook is triggered and processed, you should see its headers and content appear in the terminal where the webhook receiver is listening. If you don't, check that the <code>celery worker</code> process is running.</p>
+</li>
+</ol>
+<blockquote>
+<p><strong>Alternative Testing Tools:</strong>
+Instead of using the built-in webhook receiver, you can test webhooks with external services like <a href="https://beeceptor.com/">Beeceptor</a> or <a href="https://pipedream.com/requestbin">Pipedream RequestBin</a>. These tools let you inspect webhook payloads and troubleshoot integration issues.</p>
+</blockquote>
+<p>If a webhook does not trigger as expected, ensure that the <strong>Celery worker</strong> process is running and check the Nautobot logs for errors.</p>
 
 
 

nautobot/virtualization/forms.py

@@ -69,6 +69,16 @@ class ClusterTypeFilterForm(NautobotFilterForm):
     clusters = DynamicModelMultipleChoiceField(queryset=Cluster.objects.all(), to_field_name="name", required=False)
 
 
+class ClusterTypeBulkEditForm(NautobotBulkEditForm):
+    pk = forms.ModelMultipleChoiceField(queryset=ClusterType.objects.all(), widget=forms.MultipleHiddenInput())
+    description = forms.CharField(max_length=CHARFIELD_MAX_LENGTH, required=False)
+
+    class Meta:
+        nullable_fields = [
+            "description",
+        ]
+
+
 #
 # Cluster groups
 #
@@ -89,6 +99,16 @@ class ClusterGroupFilterForm(NautobotFilterForm):
     clusters = DynamicModelMultipleChoiceField(queryset=Cluster.objects.all(), to_field_name="name", required=False)
 
 
+class ClusterGroupBulkEditForm(NautobotBulkEditForm):
+    pk = forms.ModelMultipleChoiceField(queryset=ClusterGroup.objects.all(), widget=forms.MultipleHiddenInput())
+    description = forms.CharField(max_length=CHARFIELD_MAX_LENGTH, required=False)
+
+    class Meta:
+        nullable_fields = [
+            "description",
+        ]
+
+
 #
 # Clusters
 #

nautobot/virtualization/templates/virtualization/clustergroup.html

@@ -1,40 +1,2 @@
 {% extends 'generic/object_retrieve.html' %}
-{% load helpers %}
-
-{% block content_left_page %}
-        <div class="panel panel-default">
-            <div class="panel-heading">
-                <strong>Cluster Group</strong>
-            </div>
-            <table class="table table-hover panel-body attr-table">
-                <tr>
-                    <td>Description</td>
-                    <td>{{ object.description|placeholder }}</td>
-                </tr>
-                <tr>
-                    <td>Clusters</td>
-                    <td>
-                        <a href="{% url 'virtualization:cluster_list' %}?cluster_group={{ object.name }}">{{ cluster_table.rows|length }}</a>
-                    </td>
-                </tr>
-            </table>
-        </div>
-{% endblock content_left_page %}
-
-{% block content_right_page %}
-        <div class="panel panel-default">
-            <div class="panel-heading">
-                <strong>Clusters</strong>
-            </div>
-            {% include 'inc/table.html' with table=cluster_table %}
-            {% if perms.virtualization.add_cluster %}
-                <div class="panel-footer text-right noprint">
-                    <a href="{% url 'virtualization:cluster_add' %}?cluster_group={{ object.pk }}" class="btn btn-xs btn-primary">
-                        <span class="mdi mdi-plus-thick" aria-hidden="true"></span> Add cluster
-                    </a>
-                </div>
-            {% endif %}
-        </div>
-        {% include 'inc/paginator.html' with paginator=cluster_table.paginator page=cluster_table.page %}
-        <div class="row"></div>
-{% endblock content_right_page %}
+{% comment %}3.0 TODO: remove this template, which only exists for backward compatibility with 2.4 and earlier{% endcomment %}

nautobot/virtualization/templates/virtualization/clustertype.html

@@ -1 +1,2 @@
 {% extends 'generic/object_retrieve.html' %}
+{% comment %}3.0 TODO: remove this template, which only exists for backward compatibility with 2.4 and earlier{% endcomment %}

nautobot/virtualization/tests/test_api.py

@@ -239,7 +239,7 @@ class VirtualMachineTest(APIViewTestCases.APIViewTestCase):
         schema = ConfigContextSchema.objects.create(
             name="Schema 1", data_schema={"type": "object", "properties": {"A": {"type": "integer"}}}
         )
-        self.add_permissions("virtualization.change_virtualmachine")
+        self.add_permissions("virtualization.change_virtualmachine", "extras.view_configcontextschema")
 
         patch_data = {"local_config_context_schema": str(schema.pk)}
 
@@ -346,7 +346,12 @@ class VMInterfaceTest(APIViewTestCases.APIViewTestCase):
 
     def test_untagged_vlan_requires_mode(self):
         """Test that when an `untagged_vlan` is specified, `mode` is also required."""
-        self.add_permissions("virtualization.add_vminterface")
+        self.add_permissions(
+            "virtualization.add_vminterface",
+            "virtualization.view_virtualmachine",
+            "extras.view_status",
+            "ipam.view_vlan",
+        )
 
         # This will fail.
         url = self._get_list_url()
@@ -361,7 +366,13 @@ class VMInterfaceTest(APIViewTestCases.APIViewTestCase):
         )
 
     def test_tagged_vlan_raise_error_if_mode_not_set_to_tagged(self):
-        self.add_permissions("virtualization.add_vminterface", "virtualization.change_vminterface")
+        self.add_permissions(
+            "virtualization.add_vminterface",
+            "virtualization.change_vminterface",
+            "virtualization.view_virtualmachine",
+            "extras.view_status",
+            "ipam.view_vlan",
+        )
         vlan = VLAN.objects.get(name="VLAN 1")
         virtualmachine = VirtualMachine.objects.first()
         with self.subTest("On create, assert 400 status."):