github.statuspayload
Home > @runlightyear/github > StatusPayload
StatusPayload interface
Documentation: https://docs.github.com/webhooks-and-events/webhooks/webhook-events-and-payloads\#status
Signature:interface StatusPayload extends CommonPayload
Required Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| avatarUrl | string | null | ||
| branches | Array<{ commit: { sha: string | null; url: string | null; }; name: string; protected: boolean; }> | 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 | Commit | ||
| context | string | ||
| createdAt | string | ||
| description | string | null | The optional human-readable description added to the status. | |
| id | number | The unique identifier of the status. | |
| name | string | ||
| sha | string | The Commit SHA. | |
| state | string | The new state. Can be pending, success, failure, or error. Can be one of: pending, success, failure, error | |
| targetUrl | string | null | The optional link added to the status. | |
| updatedAt | string |