Skip to main content

received_events

Creates, updates, deletes, gets or lists a received_events resource.

Overview

Namereceived_events
TypeResource
Idgithub.activity.received_events

Fields

The following fields are returned by SELECT queries:

Response

NameDatatypeDescription
idstring
actorobjectActor (title: Actor)
created_atstring (date-time)
orgobjectActor (title: Actor)
payloadobject(opaque JSON object) (title: CreateEvent)
publicboolean
repoobject
typestring

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_received_events_for_userselectusernameper_page, pageThese are events that you've received by watching repositories and following users. If you are authenticated as the
given user, you will see private events. Otherwise, you'll only see public events.

> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
usernamestringThe handle for the GitHub user account.
pageintegerThe page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_pageintegerThe number of results per page (max 100). For more information, see "Using pagination in the REST API."

SELECT examples

These are events that you've received by watching repositories and following users. If you are authenticated as the
given user, you will see private events. Otherwise, you'll only see public events.

> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

SELECT
id,
actor,
created_at,
org,
payload,
public,
repo,
type
FROM github.activity.received_events
WHERE username = '{{ username }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;