Status
This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see "About status checks." For information about the APIs to manage commit statuses, see the GraphQL documentation or "Commit statuses" in the REST API documentation.
Actions
| Action | Sent when |
|---|---|
status | This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see "About status checks." For information about the APIs to manage commit statuses, see the GraphQL documentation or "Commit statuses" in the REST API documentation. |
Payload
Fields of the delivery for the first action above. Every action shares the event's core fields.
| Field | Type | Required | Description |
|---|---|---|---|
avatar_url | string | No | |
branches | array<object> | Yes | An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches. |
commit | object | Yes | |
context | string | Yes | |
created_at | string | Yes | |
description | string | Yes | The optional human-readable description added to the status. |
enterprise | object | No | An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured |
id | integer | Yes | The unique identifier of the status. |
installation | object | No | The GitHub App installation. Webhook payloads contain the installation property when the event is configured |
name | string | Yes | |
organization | object | No | A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an |
repository | object | Yes | The repository on GitHub where the event occurred. Webhook payloads contain the repository property |
sender | object | Yes | A GitHub user. |
sha | string | Yes | The Commit SHA. |
Subscribing
To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission.