verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The “signing” flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on her/his account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user’s account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
External DocumentationTo learn more, visit the GitHub documentation.
Parameters
| Parameter | Description |
|---|---|
| Author | GitHub login or email address by which to filter by commit author. |
| End Time | Only commits before this date will be returned. |
| Owner | The organization or person who owns the repository. github.com// |
| Page | Page number of the results to fetch. |
| Path Contains | Only commits containing this file path will be returned. |
| Per Page | The number of results per page (max 100). |
| Repo | Name of the repository owned by the owner. github.com// |
| Return All Pages | Automatically fetch all resources, page by page. |
| SHA Contains | SHA or branch to start listing commits from. Default: the repository’s default branch (usually master). |
| Start Time | Only show notifications updated after the given time. |
Example Output
{
"sha": "<string>",
"node_id": "<string>",
"commit": {
"author": {
"name": "<string>",
"email": "<string>",
"date": "2025-03-12T13:58:09Z"
},
"committer": {
"name": "<string>",
"email": "<string>",
"date": "2025-03-12T13:58:09Z"
},
"message": "<string>",
"tree": {
"sha": "<string>",
"url": "<string>"
},
"url": "<string>",
"comment_count": 2,
"verification": {
"verified": true,
"reason": "<string>",
"signature": "<string>",
"payload": "<string>",
"verified_at": "2021-10-28T16:05:50Z"
}
},
"url": "<string>",
"html_url": "<string>",
"comments_url": "<string>",
"author": {
"login": "<string>",
"id": 9613673,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"committer": {
"login": "<string>",
"id": 18570210,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"parents": [
{
"sha": "<string>",
"url": "<string>",
"html_url": "<string>"
}
]
}
Workflow Library Example
List Commits with Github and Send Results Via Email