received_events
Creates, updates, deletes, gets or lists a received_events resource.
Overview
| Name | received_events |
| Type | Resource |
| Id | github.activity.received_events |
Fields
The following fields are returned by SELECT queries:
- list_received_events_for_user
Response
| Name | Datatype | Description |
|---|---|---|
id | string | |
actor | object | Actor (title: Actor) |
created_at | string (date-time) | |
org | object | Actor (title: Actor) |
payload | object | (opaque JSON object) (title: CreateEvent) |
public | boolean | |
repo | object | |
type | string |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_received_events_for_user | select | username | per_page, page | 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. |
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.
| Name | Datatype | Description |
|---|---|---|
username | string | The handle for the GitHub user account. |
page | integer | The page number of the results to fetch. For more information, see "Using pagination in the REST API." |
per_page | integer | The number of results per page (max 100). For more information, see "Using pagination in the REST API." |
SELECT examples
- list_received_events_for_user
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 }}'
;