.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Pithub::Repos::Hooks 3pm"
.TH Pithub::Repos::Hooks 3pm "2021-02-15" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Pithub::Repos::Hooks \- Github v3 Repo Hooks API
.SH "VERSION"
.IX Header "VERSION"
version 0.01036
.SH "METHODS"
.IX Header "METHODS"
.SS "create"
.IX Subsection "create"
.IP "\(bu" 4
Create a hook
.Sp
.Vb 1
\&    POST /repos/:user/:repo/hooks
.Ve
.Sp
Examples:
.Sp
.Vb 10
\&    my $hooks  = Pithub::Repos::Hooks\->new;
\&    my $result = $hooks\->create(
\&        user => \*(Aqplu\*(Aq,
\&        repo => \*(AqPithub\*(Aq,
\&        data => {
\&            name   => \*(Aqirc\*(Aq,
\&            active => 1,
\&            config => {
\&                server => \*(Aqirc.perl.org\*(Aq,
\&                port   => 6667,
\&                room   => \*(Aqpithub\*(Aq,
\&            },
\&        },
\&    );
.Ve
.SS "delete"
.IX Subsection "delete"
.IP "\(bu" 4
Delete a hook
.Sp
.Vb 1
\&    DELETE /repos/:user/:repo/hooks/:id
.Ve
.Sp
Examples:
.Sp
.Vb 6
\&    my $hooks  = Pithub::Repos::Hooks\->new;
\&    my $result = $hooks\->delete(
\&        user    => \*(Aqplu\*(Aq,
\&        repo    => \*(AqPithub\*(Aq,
\&        hook_id => 5,
\&    );
.Ve
.SS "get"
.IX Subsection "get"
.IP "\(bu" 4
Get single hook
.Sp
.Vb 1
\&    GET /repos/:user/:repo/hooks/:id
.Ve
.Sp
Examples:
.Sp
.Vb 6
\&    my $hooks  = Pithub::Repos::Hooks\->new;
\&    my $result = $hooks\->get(
\&        user    => \*(Aqplu\*(Aq,
\&        repo    => \*(AqPithub\*(Aq,
\&        hook_id => 5,
\&    );
.Ve
.SS "list"
.IX Subsection "list"
.IP "\(bu" 4
List Hooks
.Sp
.Vb 1
\&    GET /repos/:user/:repo/hooks
.Ve
.Sp
Examples:
.Sp
.Vb 2
\&    my $hooks  = Pithub::Repos::Hooks\->new;
\&    my $result = $hooks\->tags( user => \*(Aqplu\*(Aq, repo => \*(AqPithub\*(Aq );
.Ve
.SS "test"
.IX Subsection "test"
.IP "\(bu" 4
Get single hook
.Sp
.Vb 1
\&    POST /repos/:user/:repo/hooks/:id/test
.Ve
.Sp
Examples:
.Sp
.Vb 6
\&    my $hooks  = Pithub::Repos::Hooks\->new;
\&    my $result = $hooks\->test(
\&        user    => \*(Aqplu\*(Aq,
\&        repo    => \*(AqPithub\*(Aq,
\&        hook_id => 5,
\&    );
.Ve
.SS "update"
.IX Subsection "update"
.IP "\(bu" 4
Update/edit a hook
.Sp
.Vb 1
\&    PATCH /repos/:user/:repo/hooks/:id
.Ve
.Sp
Examples:
.Sp
.Vb 10
\&    my $hooks  = Pithub::Repos::Hooks\->new;
\&    my $result = $hooks\->update(
\&        user    => \*(Aqplu\*(Aq,
\&        repo    => \*(AqPithub\*(Aq,
\&        hook_id => 5,
\&        data    => {
\&            name   => \*(Aqirc\*(Aq,
\&            active => 1,
\&            config => {
\&                server => \*(Aqirc.freenode.net\*(Aq,
\&                port   => 6667,
\&                room   => \*(Aqpithub\*(Aq,
\&            },
\&        },
\&    );
.Ve
.SH "EVENTS"
.IX Header "EVENTS"
Active hooks can be configured to trigger for one or more events.
The default event is push. The available events are:
.IP "\(bu" 4
commit_comment \- Any time a Commit is commented on.
.IP "\(bu" 4
download \- Any time a Download is added to the Repository.
.IP "\(bu" 4
fork \- Any time a Repository is forked.
.IP "\(bu" 4
fork_apply \- Any time a patch is applied to the Repository from
the Fork Queue.
.IP "\(bu" 4
gollum \- Any time a Wiki page is updated.
.IP "\(bu" 4
issues \- Any time an Issue is opened or closed.
.IP "\(bu" 4
issue_comment \- Any time an Issue is commented on.
.IP "\(bu" 4
member \- Any time a User is added as a collaborator to a
non-Organization Repository.
.IP "\(bu" 4
public \- Any time a Repository changes from private to public.
.IP "\(bu" 4
pull_request \- Any time a Pull Request is opend, closed, or
synchronized (updated due to a new push in the branch that
the pull request is tracking).
.IP "\(bu" 4
push \- Any git push to a Repository.
.IP "\(bu" 4
watch \- Any time a User watches the Repository.
.SH "AUTHOR"
.IX Header "AUTHOR"
Johannes Plunien <plu@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2011\-2019 by Johannes Plunien.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.