community.general.github_webhook_info – Query information about GitHub webhooks¶
Note
This plugin is part of the community.general collection (version 2.5.1).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.github_webhook_info
.
Synopsis¶
Query information about GitHub webhooks
This module was called
github_webhook_facts
before Ansible 2.9. The usage did not change.
Requirements¶
The below requirements are needed on the host that executes this module.
PyGithub >= 1.3.5
Parameters¶
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:
Authors¶
Chris St. Pierre (@stpierre)