Properties
| Name | Type | Description |
|---|---|---|
| avatar_url | string | |
| branches | array | 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 | |
| context | string | |
| created_at | string | |
| description | string | The optional human-readable description added to the status. |
| enterprise | object | |
| id | integer | The unique identifier of the status. |
| installation | object | |
| name | string | |
| organization | object | |
| repository | object | |
| sender | object | |
| sha | string | The Commit SHA. |
| state | string | The new state. Can be `pending`, `success`, `failure`, or `error`. |
| target_url | string | The optional link added to the status. |
| updated_at | string |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/webhook-status",
"title": "status event",
"type": "object",
"properties": {
"avatar_url": {
"type": "string",
"nullable": true,
"format": "uri"
},
"branches": {
"description": "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.",
"type": "array",
"items": {
"type": "object",
"properties": {
"commit": {
"type": "object",
"properties": {
"sha": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true,
"format": "uri"
}
},
"required": [
"sha",
"url"
]
},
"name": {
"type": "string"
},
"protected": {
"type": "boolean"
}
},
"required": [
"name",
"commit",
"protected"
]
}
},
"commit": {
"type": "object",
"properties": {
"author": {
"title": "User",
"type": "object",
"nullable": true,
"properties": {
"avatar_url": {
"type": "string",
"format": "uri"
},
"deleted": {
"type": "boolean"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"format": "uri-template"
},
"followers_url": {
"type": "string",
"format": "uri"
},
"following_url": {
"type": "string",
"format": "uri-template"
},
"gists_url": {
"type": "string",
"format": "uri-template"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string",
"format": "uri"
},
"received_events_url": {
"type": "string",
"format": "uri"
},
"repos_url": {
"type": "string",
"format": "uri"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string",
"format": "uri-template"
},
"subscriptions_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string",
"enum": [
"Bot",
"User",
"Organization"
]
},
"url": {
"type": "string",
"format": "uri"
}
}
},
"comments_url": {
"type": "string",
"format": "uri"
},
"commit": {
"type": "object",
"properties": {
"author": {
"allOf": [
{
"title": "Committer",
"description": "Metaproperties for Git author/committer information.",
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"email": {
"type": "string",
"nullable": true,
"format": "email"
},
"name": {
"description": "The git author's name.",
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"email",
"name"
]
},
{
"type": "object",
"properties": {
"date": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"date"
]
}
]
},
"comment_count": {
"type": "integer"
},
"committer": {
"allOf": [
{
"title": "Committer",
"description": "Metaproperties for Git author/committer information.",
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"email": {
"type": "string",
"nullable": true,
"format": "email"
},
"name": {
"description": "The git author's name.",
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"email",
"name"
]
},
{
"type": "object",
"properties": {
"date": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"date"
]
}
]
},
"message": {
"type": "string"
},
"tree": {
"type": "object",
"properties": {
"sha": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"sha",
"url"
]
},
"url": {
"type": "string",
"format": "uri"
},
"verification": {
"type": "object",
"properties": {
"payload": {
"type": "string",
"nullable": true
},
"reason": {
"type": "string",
"enum": [
"expired_key",
"not_signing_key",
"gpgverify_error",
"gpgverify_unavailable",
"unsigned",
"unknown_signature_type",
"no_user",
"unverified_email",
"bad_email",
"unknown_key",
"malformed_signature",
"invalid",
"valid",
"bad_cert",
"ocsp_pending"
]
},
"signature": {
"type": "string",
"nullable": true
},
"verified": {
"type": "boolean"
}
},
"required": [
"verified",
"reason",
"signature",
"payload"
]
}
},
"required": [
"author",
"committer",
"message",
"tree",
"url",
"comment_count",
"verification"
]
},
"committer": {
"title": "User",
"type": "object",
"nullable": true,
"properties": {
"avatar_url": {
"type": "string",
"format": "uri"
},
"deleted": {
"type": "boolean"
},
"email": {
"type": "string",
"nullable": true
},
"events_url": {
"type": "string",
"format": "uri-template"
},
"followers_url": {
"type": "string",
"format": "uri"
},
"following_url": {
"type": "string",
"format": "uri-template"
},
"gists_url": {
"type": "string",
"format": "uri-template"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string",
"format": "uri"
},
"received_events_url": {
"type": "string",
"format": "uri"
},
"repos_url": {
"type": "string",
"format": "uri"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string",
"format": "uri-template"
},
"subscriptions_url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string",
"enum": [
"Bot",
"User",
"Organization"
]
},
"url": {
"type": "string",
"format": "uri"
}
}
},
"html_url": {
"type": "string",
"format": "uri"
},
"node_id": {
"type": "string"
},
"parents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"html_url": {
"type": "string",
"format": "uri"
},
"sha": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"sha",
"url",
"html_url"
]
}
},
"sha": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"sha",
"node_id",
"commit",
"url",
"html_url",
"comments_url",
"author",
"committer",
"parents"
]
},
"context": {
"type": "string"
},
"created_at": {
"type": "string"
},
"description": {
"description": "The optional human-readable description added to the status.",
"type": "string",
"nullable": true
},
"enterprise": {
"$ref": "#/components/schemas/enterprise-webhooks"
},
"id": {
"description": "The unique identifier of the status.",
"type": "integer"
},
"installation": {
"$ref": "#/components/schemas/simple-installation"
},
"name": {
"type": "string"
},
"organization": {
"$ref": "#/components/schemas/organization-simple-webhooks"
},
"repository": {
"$ref": "#/components/schemas/repository-webhooks"
},
"sender": {
"$ref": "#/components/schemas/simple-user-webhooks"
},
"sha": {
"description": "The Commit SHA.",
"type": "string"
},
"state": {
"description": "The new state. Can be `pending`, `success`, `failure`, or `error`.",
"type": "string",
"enum": [
"pending",
"success",
"failure",
"error"
]
},
"target_url": {
"description": "The optional link added to the status.",
"type": "string",
"nullable": true
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"sha",
"name",
"target_url",
"context",
"description",
"state",
"commit",
"branches",
"created_at",
"updated_at",
"repository",
"sender"
]
}