community.general.github_webhook_info module – Query information about GitHub webhooks

Note

This module is part of the community.general collection (version 4.8.1).

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_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

Parameter

Comments

github_url

string

Base URL of the github api

Default: “https://api.github.com”

password

string

Password to authenticate to GitHub with

repository

aliases: repo

string / required

Full name of the repository to configure a hook for

token

string

Token to authenticate to GitHub with

user

string / required

User to authenticate to GitHub as

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

hooks

list / elements=string

A list of hooks that exist for the repo

Returned: always

Sample: “[{\”has_shared_secret\”: true,\n \”url\”: \”https://jenkins.example.com/ghprbhook/\”,\n \”events\”: [\”issue_comment\”, \”pull_request\”],\n \”insecure_ssl\”: \”1\”,\n \”content_type\”: \”json\”,\n \”active\”: true,\n \”id\”: 6206,\n \”last_response\”: {\”status\”: \”active\”, \”message\”: \”OK\”, \”code\”: 200}}]\n”

Authors

  • Chris St. Pierre (@stpierre)