netbox_webhook_module.rst

orphan

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 <ansible_collections.netbox.netbox.netbox_webhook_module_requirements> for details.

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

ansible-version-added

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

X{1}{3}X{2}{3}

Parameter	Comments
ansible-option-title cert any	Certificate path
ansible-option-title data dictionary / required	Defines the custom field
ansible-option-title additional_headers string	User-supplied HTTP headers. Supports jinja2 code.
ansible-option-title body_template string	Body template for webhook. Supports jinja2 code.
ansible-option-title ca_file_path string	CA certificate file to use for SSL verification
ansible-option-title conditions dictionary	A set of conditions which determine whether the webhook will be generated.
ansible-option-title content_types list / elements=any	The content type(s) to apply this webhook to Required when state=present
ansible-option-title enabled boolean	Enable/disable the webhook. ansible-option-line Choices: false true
ansible-option-title http_content_type string	The HTTP content type.
ansible-option-title http_method any	HTTP method of the webhook.
ansible-option-title name string / required	Name of the webhook
ansible-option-title payload_url string	URL for the webhook to use. Required when state=present
ansible-option-title secret string	Secret key to generate X-Hook-Signature to include in the payload.
ansible-option-title ssl_verification boolean	Enable ssl verification. ansible-option-line Choices: false true
ansible-option-title type_create boolean	Call this webhook when a matching object is created ansible-option-line Choices: false true
ansible-option-title type_delete boolean	Call this webhook when a matching object is deleted ansible-option-line Choices: false true
ansible-option-title type_update boolean	Call this webhook when a matching object is updated ansible-option-line Choices: false true
ansible-option-title netbox_token string / required	The NetBox API token.
ansible-option-title netbox_url string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
ansible-option-title query_params list / elements=string	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.
ansible-option-title state string	The state of the object. ansible-option-line Choices: "present" ← (default) "absent"
ansible-option-title validate_certs any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. ansible-option-line 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 <common_return_values>, the following are the fields unique to this module:

X{1}{3}X{2}{3}

Key	Description
ansible-option-title msg string	Message indicating failure or info about what has been achieved ansible-option-line Returned: always
ansible-option-title webhook dictionary	Serialized object as created/existent/updated/deleted within NetBox ansible-option-line Returned: always

Authors

• Martin Rødvand (@rodvand)

Collection links

• title: "Issue Tracker" url: "https://github.com/netbox-community/ansible_modules/issues" external: true
• title: "Repository (Sources)" url: "https://github.com/netbox-community/ansible_modules" external: true