jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-22 11:26:57 -05:00
Code Issues Projects Releases Wiki Activity

github-event-types.md : add missed event object common properties into list

Browse Source 
`public`, `created_at`, `org.id`, `org.login`, `org.gravatar_id`, `org.url`, `org.avatar_url` are added using the same ordering as used on https://api.github.com/events
This commit is contained in:
NickVeld
2022-05-24 06:19:02 +02:00
committed by GitHub
parent 99d86b111c
commit b8a70f47f1
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
content/developers/webhooks-and-events/events/github-event-types.md
View File

@@ -38,6 +38,14 @@ The event objects returned from the Events API endpoints have the same structure
| `repo.name` | The name of the repository, which includes the owner and repository name. For example, `octocat/hello-world` is the name of the `hello-world` repository owned by the `octocat` personal account. |
| `repo.url` | The REST API URL used to retrieve the repository object, which includes additional repository information. |
| `payload` | The event payload object is unique to the event type. See the event type below for the event API `payload` object. |
| `public` | The property shows whether the event can be shown to all API callers or only authorized ones. |
| `created_at` | The date and time when the event was triggered. It is formatted according to ISO 8601. |
| `org` | The organization that was chosen by the actor to perform action that triggers the event.<br />_The property appears in the event object only if it is applicable._ |
| `org.id` | The unique identifier for the organization. |
| `org.login` | The name of the organization. |
| `org.gravatar_id` | The unique identifier of the Gravatar profile for the organization. |
| `org.url` | The REST API URL used to retrieve the organization object, which includes additional organization information. |
| `org.avatar_url` | The URL of the organization's profile image. |
### Example WatchEvent event object