{
  "generated_from": "hookdeck/webhook-registry",
  "registry_commit": "a24c8d9784c9e9fe937c63f76adbce108201378f",
  "registry_committed_at": "2026-11-19T08:56:09Z",
  "disclaimer": "Independent reference. Not affiliated with GitHub.",
  "vendor": "github",
  "event": "deployment_status",
  "resource": "deployment",
  "url": "https://hookdeck.com/webhooks/github/events#deployment_status",
  "description": "A deployment's status changes",
  "trigger": null,
  "listed_in": "https://docs.github.com/en/webhooks/webhook-events-and-payloads",
  "confidence": "documented",
  "schema_source": "from GitHub docs (example)",
  "identified_by": "x-github-event header and action field in the body",
  "payload": {
    "provenance": "doc-example",
    "value_realism": "doc-example-values",
    "field_count": 275,
    "key_fields": [],
    "delivery": {
      "title": "From GitHub docs",
      "content_type": "application/json",
      "headers": []
    },
    "body": {
      "deployment_status": {
        "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746/statuses/209916254",
        "id": 209916254,
        "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMyMDk5MTYyNTQ=",
        "state": "in_progress",
        "creator": {
          "login": "github-pages[bot]",
          "id": 52472962,
          "node_id": "MDM6Qm90NTI0NzI5NjI=",
          "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
          "gravatar_id": "",
          "url": "https://api.github.com/users/github-pages%5Bbot%5D",
          "html_url": "https://github.com/apps/github-pages",
          "followers_url": "https://api.github.com/users/github-pages%5Bbot%5D/followers",
          "following_url": "https://api.github.com/users/github-pages%5Bbot%5D/following{/other_user}",
          "gists_url": "https://api.github.com/users/github-pages%5Bbot%5D/gists{/gist_id}",
          "starred_url": "https://api.github.com/users/github-pages%5Bbot%5D/starred{/owner}{/repo}",
          "subscriptions_url": "https://api.github.com/users/github-pages%5Bbot%5D/subscriptions",
          "organizations_url": "https://api.github.com/users/github-pages%5Bbot%5D/orgs",
          "repos_url": "https://api.github.com/users/github-pages%5Bbot%5D/repos",
          "events_url": "https://api.github.com/users/github-pages%5Bbot%5D/events{/privacy}",
          "received_events_url": "https://api.github.com/users/github-pages%5Bbot%5D/received_events",
          "type": "Bot",
          "site_admin": false
        },
        "description": "",
        "environment": "github-pages",
        "target_url": "https://github.com/Codertocat/Hello-World/runs/145988746?check_suite_focus=true",
        "created_at": "2022-01-03T01:28:40Z",
        "updated_at": "2022-01-03T01:28:40Z",
        "deployment_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746",
        "repository_url": "https://api.github.com/repos/Codertocat/Hello-World",
        "environment_url": "",
        "log_url": "https://github.com/CorsixTH/CorsixTH/runs/4687056418?check_suite_focus=true",
        "performed_via_github_app": null
      },
      "deployment": {
        "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746",
        "id": 145988746,
        "node_id": "MDEwOkRlcGxveW1lbnQxNDU5ODg3NDY=",
        "task": "deploy",
        "original_environment": "github-pages",
        "environment": "github-pages",
        "description": null,
        "created_at": "2022-01-03T01:28:30Z",
        "updated_at": "2022-01-03T01:28:40Z",
        "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/145988746/statuses",
        "repository_url": "https://api.github.com/repos/Codertocat/Hello-World",
        "creator": {
          "login": "github-pages[bot]",
          "id": 52472962,
          "node_id": "MDM6Qm90NTI0NzI5NjI=",
          "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
          "gravatar_id": "",
          "url": "https://api.github.com/users/github-pages%5Bbot%5D",
          "html_url": "https://github.com/apps/github-pages",
          "followers_url": "https://api.github.com/users/github-pages%5Bbot%5D/followers",
          "following_url": "https://api.github.com/users/github-pages%5Bbot%5D/following{/other_user}",
          "gists_url": "https://api.github.com/users/github-pages%5Bbot%5D/gists{/gist_id}",
          "starred_url": "https://api.github.com/users/github-pages%5Bbot%5D/starred{/owner}{/repo}",
          "subscriptions_url": "https://api.github.com/users/github-pages%5Bbot%5D/subscriptions",
          "organizations_url": "https://api.github.com/users/github-pages%5Bbot%5D/orgs",
          "repos_url": "https://api.github.com/users/github-pages%5Bbot%5D/repos",
          "events_url": "https://api.github.com/users/github-pages%5Bbot%5D/events{/privacy}",
          "received_events_url": "https://api.github.com/users/github-pages%5Bbot%5D/received_events",
          "type": "Bot",
          "site_admin": false
        },
        "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e",
        "ref": "master",
        "payload": {},
        "transient_environment": false,
        "production_environment": false,
        "performed_via_github_app": null
      },
      "action": "created",
      "check_run": {
        "id": 128620228,
        "name": "deploy",
        "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=",
        "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
        "external_id": "e07742bd-189a-5079-918b-43f8b2f94b89",
        "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228",
        "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228?check_suite_focus=true",
        "details_url": "https://github.com/Codertocat/Hello-World/runs/128620228?check_suite_focus=true",
        "status": "in_progress",
        "conclusion": null,
        "started_at": "2022-01-03T01:28:39Z",
        "completed_at": null
      },
      "workflow_run": {
        "id": 289782451,
        "name": "pages build and deployment",
        "node_id": "WFR_kwLOALyme85iNFsT",
        "head_branch": "gh-pages",
        "head_sha": "9e602444f49b8b69c3a9a51fa97a115f3d323508",
        "run_number": 1,
        "event": "dynamic",
        "status": "in_progress",
        "conclusion": null,
        "workflow_id": 17248323,
        "check_suite_id": 4812750241,
        "check_suite_node_id": "CS_kwDOALyme88AAAABHty9oQ",
        "url": "https://api.github.com/repos/Codertocat/Hello-World/actions/runs/289782451",
        "html_url": "https://github.com/Codertocat/Hello-World/actions/runs/289782451",
        "pull_requests": [],
        "created_at": "2022-01-03T01:27:48Z",
        "updated_at": "2022-01-03T01:28:40Z",
        "run_attempt": 1,
        "run_started_at": "2022-01-03T01:27:48Z",
        "actor": {
          "avatar_url": "https://avatars0.githubusercontent.com/u/15669918?v=4",
          "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
          "followers_url": "https://api.github.com/users/Codertocat/followers",
          "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
          "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
          "gravatar_id": "",
          "html_url": "https://github.com/Codertocat",
          "id": 15669918,
          "login": "Codertocat",
          "node_id": "MDQ6VXNlcjE1NjY5OTE4",
          "organizations_url": "https://api.github.com/users/Codertocat/orgs",
          "received_events_url": "https://api.github.com/users/Codertocat/received_events",
          "repos_url": "https://api.github.com/users/Codertocat/repos",
          "site_admin": false,
          "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
          "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
          "type": "User",
          "url": "https://api.github.com/users/Codertocat"
        },
        "triggering_actor": {
          "avatar_url": "https://avatars0.githubusercontent.com/u/15669918?v=4",
          "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
          "followers_url": "https://api.github.com/users/Codertocat/followers",
          "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
          "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
          "gravatar_id": "",
          "html_url": "https://github.com/Codertocat",
          "id": 15669918,
          "login": "Codertocat",
          "node_id": "MDQ6VXNlcjE1NjY5OTE4",
          "organizations_url": "https://api.github.com/users/Codertocat/orgs",
          "received_events_url": "https://api.github.com/users/Codertocat/received_events",
          "repos_url": "https://api.github.com/users/Codertocat/repos",
          "site_admin": false,
          "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
          "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
          "type": "User",
          "url": "https://api.github.com/users/Codertocat"
        }
      },
      "repository": {
        "id": 186853002,
        "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
        "name": "Hello-World",
        "full_name": "Codertocat/Hello-World",
        "private": false,
        "owner": {
          "login": "Codertocat",
          "id": 21031067,
          "node_id": "MDQ6VXNlcjIxMDMxMDY3",
          "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
          "gravatar_id": "",
          "url": "https://api.github.com/users/Codertocat",
          "html_url": "https://github.com/Codertocat",
          "followers_url": "https://api.github.com/users/Codertocat/followers",
          "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
          "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
          "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
          "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
          "organizations_url": "https://api.github.com/users/Codertocat/orgs",
          "repos_url": "https://api.github.com/users/Codertocat/repos",
          "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
          "received_events_url": "https://api.github.com/users/Codertocat/received_events",
          "type": "User",
          "site_admin": false
        },
        "html_url": "https://github.com/Codertocat/Hello-World",
        "description": null,
        "fork": false,
        "url": "https://api.github.com/repos/Codertocat/Hello-World",
        "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
        "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
        "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
        "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
        "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
        "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
        "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
        "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
        "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
        "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
        "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
        "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
        "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
        "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
        "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
        "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
        "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
        "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
        "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
        "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
        "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
        "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
        "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
        "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
        "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
        "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
        "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
        "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
        "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
        "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
        "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
        "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
        "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
        "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
        "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
        "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
        "created_at": "2019-05-15T15:19:25Z",
        "updated_at": "2019-05-15T15:20:41Z",
        "pushed_at": "2019-05-15T15:20:52Z",
        "git_url": "git://github.com/Codertocat/Hello-World.git",
        "ssh_url": "git@github.com:Codertocat/Hello-World.git",
        "clone_url": "https://github.com/Codertocat/Hello-World.git",
        "svn_url": "https://github.com/Codertocat/Hello-World",
        "homepage": null,
        "size": 0,
        "stargazers_count": 0,
        "watchers_count": 0,
        "language": "Ruby",
        "has_issues": true,
        "has_projects": true,
        "has_downloads": true,
        "has_wiki": true,
        "has_pages": true,
        "forks_count": 1,
        "mirror_url": null,
        "archived": false,
        "disabled": false,
        "open_issues_count": 2,
        "license": null,
        "forks": 1,
        "open_issues": 2,
        "watchers": 0,
        "default_branch": "master",
        "is_template": false,
        "topics": [],
        "visibility": "public",
        "web_commit_signoff_required": false,
        "custom_properties": {}
      },
      "organization": {
        "login": "Octocoders",
        "id": 38302899,
        "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
        "url": "https://api.github.com/orgs/Octocoders",
        "repos_url": "https://api.github.com/orgs/Octocoders/repos",
        "events_url": "https://api.github.com/orgs/Octocoders/events",
        "hooks_url": "https://api.github.com/orgs/Octocoders/hooks",
        "issues_url": "https://api.github.com/orgs/Octocoders/issues",
        "members_url": "https://api.github.com/orgs/Octocoders/members{/member}",
        "public_members_url": "https://api.github.com/orgs/Octocoders/public_members{/member}",
        "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
        "description": ""
      },
      "sender": {
        "login": "Codertocat",
        "id": 21031067,
        "node_id": "MDQ6VXNlcjIxMDMxMDY3",
        "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
        "gravatar_id": "",
        "url": "https://api.github.com/users/Codertocat",
        "html_url": "https://github.com/Codertocat",
        "followers_url": "https://api.github.com/users/Codertocat/followers",
        "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
        "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
        "organizations_url": "https://api.github.com/users/Codertocat/orgs",
        "repos_url": "https://api.github.com/users/Codertocat/repos",
        "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
        "received_events_url": "https://api.github.com/users/Codertocat/received_events",
        "type": "User",
        "site_admin": false
      },
      "installation": {
        "id": 1,
        "node_id": "MDIzOkludGVncmF0aW9uSW5zdGFsbGF0aW9uMQ=="
      }
    }
  }
}