netbox.netbox.netbox_webhook module – Creates, updates or deletes webhook configuration within NetBox

Note

This module is part of the netbox.netbox collection (version 3.17.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netbox.netbox. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: netbox.netbox.netbox_webhook.

New in netbox.netbox 3.6.0

Synopsis

  • Creates, updates or removes webhook configuration within NetBox

Requirements

The below requirements are needed on the host that executes this module.

  • pynetbox

Parameters

Parameter

Comments

cert

Certificate path

data

Defines the custom field

additional_headers

User-supplied HTTP headers. Supports jinja2 code.

body_template

Body template for webhook. Supports jinja2 code.

ca_file_path

CA certificate file to use for SSL verification

conditions

A set of conditions which determine whether the webhook will be generated.

content_types

The content type(s) to apply this webhook to

Required when state=present

enabled

http_content_type

The HTTP content type.

http_method

HTTP method of the webhook.

name

Name of the webhook

payload_url

URL for the webhook to use.

Required when state=present

secret

Secret key to generate X-Hook-Signature to include in the payload.

ssl_verification

type_create

type_delete

type_update

netbox_token

The NetBox API token.

netbox_url

The URL of the NetBox instance.

Must be accessible by the Ansible control host.

query_params

This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined

in plugins/module_utils/netbox_utils.py and provides control to users on what may make

an object unique in their environment.

state

validate_certs

If no, SSL certificates will not be validated.

This should only be used on personally controlled sites using a self-signed certificates.

:ansible-option-default-bold:`Default:` :ansible-option-default:`true`

Notes

Note

  • This should be ran with connection local and hosts localhost

  • Use !unsafe when adding jinja2 code to additional_headers or body_template

Examples

- name: "Test NetBox webhook module"
  connection: local
  hosts: localhost
  tasks:
    - name: Create a webhook
      netbox_webhook:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          content_types:
            - dcim.device
          name: Example Webhook
          type_create: yes
          payload_url: https://payload.url/
          body_template: !unsafe >-
            {{ data }}

    - name: Update the webhook to run on delete
      netbox_webhook:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Example Webhook
          type_create: yes
          type_delete: yes
          payload_url: https://payload.url/
          body_template: !unsafe >-
            {{ data }}

    - name: Delete the webhook
      netbox_webhook:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Example Webhook
          type_create: yes
          type_delete: yes
          payload_url: https://payload.url/
          body_template: !unsafe >-
            {{ data }}
        state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

msg

Message indicating failure or info about what has been achieved

:ansible-option-returned-bold:`Returned:` always

webhook

Serialized object as created/existent/updated/deleted within NetBox

:ansible-option-returned-bold:`Returned:` always

Authors

  • Martin Rødvand (@rodvand)