Pithub::Events(3pm)

πŸ“¦
version 0.01043 Β· 4 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

πŸ’– NAME πŸ’–

Pithub::Events β€” bestie, it's the Github v3 Events API wrapper and it's literally the whole point of this page πŸŽ€


✨ VERSION ✨

version 0.01043 β€” yes queen, that's the one you're running 🌸


πŸ¦‹ METHODS πŸ¦‹

okay so here's the tea: every single method below is just a lil' door into one Github endpoint. Same vibe every time β€” make an object, pass some named args, get your events back. Let's go πŸ’…

🌈 issue

  • List issue events for a repository
GET /repos/:user/:repo/issues/events

Examples:

my $e      = Pithub::Events->new;
my $result = $e->issue(
    user => 'plu',
    repo => 'Pithub',
);

🌈 network

  • List public events for a network of repositories
GET /networks/:user/:repo/events

Examples:

my $e      = Pithub::Events->new;
my $result = $e->network(
    user => 'plu',
    repo => 'Pithub',
);

🌈 org

  • List public events for an organization
GET /orgs/:org/events

Examples:

my $e = Pithub::Events->new;
my $result = $e->org( org => 'CPAN-API' );

🌈 org_for_user

  • List events for an organization
GET /users/:user/events/orgs/:org

Examples:

my $e = Pithub::Events->new;
my $result = $e->org(
    org  => 'CPAN-API',
    user => 'plu',
);
πŸ‘€ not me pointing out that the example here calls org and not org_for_user β€” that's exactly how it's written in the original, so I'm keeping it character for character, no cap.

🌈 public

  • List public events
GET /events

Examples:

my $e      = Pithub::Events->new;
my $result = $e->public;

🌈 repos

  • List repository events
GET /repos/:user/:repo/events

Examples:

my $e      = Pithub::Events->new;
my $result = $e->repos(
    user => 'plu',
    repo => 'Pithub',
);

🌈 user_performed

  • List events performed by a user
GET /users/:user/events

If you're authenticated as the given user, you'll see your private events πŸ‘‘. Otherwise? Only the public ones, sorry babe πŸ™ˆ.

Examples:

my $e = Pithub::Events->new;
my $result = $e->user_performed( user => 'plu' );

# List public events performed by a user
my $e      = Pithub::Events->new;
my $result = $e->user_performed(
    user   => 'plu',
    public => 1,
);

🌈 user_received

  • List events that a user has received
GET /users/:user/received_events

These are the events you've received by watching repos and following users 🫢. If you're authenticated as the given user, you get the private ones. Otherwise it's public-only hours πŸ’€.

Examples:

my $e = Pithub::Events->new;
my $result = $e->user_received( user => 'plu' );

# List public events that a user has received
my $e      = Pithub::Events->new;
my $result = $e->user_received(
    user   => 'plu',
    public => 1,
);

πŸ‘‘ AUTHOR πŸ‘‘

Johannes Plunien <plu@cpan.org> β€” the icon, the moment, the main character πŸŽ€


This software is copyright (c) 2011 by Johannes Plunien.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. slay, genuinely πŸ’–


perl v5.40.1 Β· 2025-06-08 Β· Pithub::Events(3pm)

and that's the whole page bestie, go forth and fetch your events βœ¨πŸ¦‹πŸ’…

πŸ“¦ where this page comes from