You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.github_webhook – Manage GitHub webhooks

Note

This plugin is part of the community.general collection (version 3.8.3).

You might already have this collection installed if you are using the ansible package. 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 community.general.

To use it in a playbook, specify: community.general.github_webhook.

Synopsis

• Create and delete GitHub webhooks

Requirements

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

• PyGithub >= 1.3.5

Parameters

Parameter	Comments
active boolean	Whether or not the hook is active Choices: no yes ← (default)
content_type string	The media type used to serialize the payloads Choices: form ← (default) json
events list / elements=string	A list of GitHub events the hook is triggered for. Events are listed at https://developer.github.com/v3/activity/events/types/. Required unless state is absent
github_url string	Base URL of the GitHub API Default: “https://api.github.com”
insecure_ssl boolean	Flag to indicate that GitHub should skip SSL verification when calling the hook. Choices: no ← (default) yes
password string	Password to authenticate to GitHub with
repository aliases: repo string / required	Full name of the repository to configure a hook for
secret string	The shared secret between GitHub and the payload URL.
state string	Whether the hook should be present or absent Choices: absent present ← (default)
token string	Token to authenticate to GitHub with
url string / required	URL to which payloads will be delivered
user string / required	User to authenticate to GitHub as

Examples

- name: Create a new webhook that triggers on push (password auth)
  community.general.github_webhook:
    repository: ansible/ansible
    url: https://www.example.com/hooks/
    events:
      - push
    user: "{{ github_user }}"
    password: "{{ github_password }}"

- name: Create a new webhook in a github enterprise installation with multiple event triggers (token auth)
  community.general.github_webhook:
    repository: myorg/myrepo
    url: https://jenkins.example.com/ghprbhook/
    content_type: json
    secret: "{{ github_shared_secret }}"
    insecure_ssl: True
    events:
      - issue_comment
      - pull_request
    user: "{{ github_user }}"
    token: "{{ github_user_api_token }}"
    github_url: https://github.example.com

- name: Delete a webhook (password auth)
  community.general.github_webhook:
    repository: ansible/ansible
    url: https://www.example.com/hooks/
    state: absent
    user: "{{ github_user }}"
    password: "{{ github_password }}"

Return Values

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

Key	Description
hook_id integer	The GitHub ID of the hook created/updated Returned: when state is ‘present’ Sample: 6206

Authors

• Chris St. Pierre (@stpierre)