community.general.github_webhook module – Manage GitHub webhooks
Note
This module is part of the community.general collection (version 9.5.0).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
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 |
---|---|
Whether or not the hook is active Choices:
|
|
The media type used to serialize the payloads Choices:
|
|
A list of GitHub events the hook is triggered for. Events are listed at https://developer.github.com/v3/activity/events/types/. Required unless |
|
Base URL of the GitHub API Default: |
|
Flag to indicate that GitHub should skip SSL verification when calling the hook. Choices:
|
|
Password to authenticate to GitHub with |
|
Full name of the repository to configure a hook for |
|
The shared secret between GitHub and the payload URL. |
|
Whether the hook should be present or absent Choices:
|
|
Token to authenticate to GitHub with |
|
URL to which payloads will be delivered |
|
User to authenticate to GitHub as |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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 |
---|---|
The GitHub ID of the hook created/updated Returned: when state is ‘present’ Sample: |