patch.extras.webhooks.yaml

# This action was auto generated from the NetBox API Swagger Spec
# NetBox API version: 4.0
description: "Patch a webhook object."
enabled: true
entry_point: run.py
name: patch.extras.webhooks
parameters:
  endpoint_uri:
    default: "/extras/webhooks/{{ id }}/"
    immutable: true
    type: string
  http_verb:
    default: patch
    immutable: true
    type: string
  get_detail_route_eligible:
    default: true
    immutable: true
    type: boolean
  name:
    required: false
    type: string
    description: "Name"
  description:
    required: false
    type: string
    description: "Description"
  payload_url:
    required: false
    type: string
    description: "URL"
  http_method:
    required: false
    type: string
    description: "* `GET` - GET
* `POST` - POST
* `PUT` - PUT
* `PATCH` - PATCH
* `DELETE` - DELETE"
  http_content_type:
    required: false
    type: string
    description: "The complete list of official content types is available <a href="https://www.iana.org/assignments/media-types/media-types.xhtml">here</a>."
  additional_headers:
    required: false
    type: string
    description: "User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format <code>Name: Value</code>. Jinja2 template processing is supported with the same context as the request body (below)."
  body_template:
    required: false
    type: string
    description: "Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: <code>event</code>, <code>model</code>, <code>timestamp</code>, <code>username</code>, <code>request_id</code>, and <code>data</code>."
  secret:
    required: false
    type: string
    description: "When provided, the request will include a <code>X-Hook-Signature</code> header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request."
  ssl_verification:
    required: false
    type: boolean
    description: "Enable SSL certificate verification. Disable with caution!"
  ca_file_path:
    required: false
    type: string
    description: "The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults."
  custom_fields:
    required: false
    type: object
    description: "Custom fields"
  tags:
    required: false
    type: array
    description: "Array of tag strings"
  id:
    required: true
    type: integer
    description: "ID of the object to patch."
runner_type: python-script