community.general.github_webhook_info module – Query information about GitHub webhooks
Note
This module is part of the community.general collection (version 8.6.4).
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_info
.
Synopsis
Query information about GitHub webhooks
Aliases: source_control.github.github_webhook_info
Requirements
The below requirements are needed on the host that executes this module.
PyGithub >= 1.3.5
Parameters
Parameter |
Comments |
---|---|
Base URL of the github api Default: |
|
Password to authenticate to GitHub with |
|
Full name of the repository to configure a hook for |
|
Token to authenticate to GitHub with |
|
User to authenticate to GitHub as |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: List hooks for a repository (password auth)
community.general.github_webhook_info:
repository: ansible/ansible
user: "{{ github_user }}"
password: "{{ github_password }}"
register: ansible_webhooks
- name: List hooks for a repository on GitHub Enterprise (token auth)
community.general.github_webhook_info:
repository: myorg/myrepo
user: "{{ github_user }}"
token: "{{ github_user_api_token }}"
github_url: https://github.example.com/api/v3/
register: myrepo_webhooks
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A list of hooks that exist for the repo Returned: always Sample: |