This page was generated based on Github’s Documentation. See our welcome page for context and details.

Github Event `deployment_status` #

Github Action Trigger #

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`deployment_status`	Not applicable	Commit to be deployed	Branch or tag to be deployed (empty if commit)

Note: When a deployment status’s state is set to inactive, a workflow run will not be triggered.

Runs your workflow when a third party provides a deployment status. Deployments created with a commit SHA may not have a Git ref. For information about the APIs to create a deployment status, see “Mutations” in the GraphQL API documentation or “REST API endpoints for deployments.”

For example, you can run a workflow when the deployment_status event occurs.

on:
  deployment_status

Event Payload #

source

Activities: created

Common Fields #

These fields are common to every event types available with this trigger.

field	type	required	description
`github.event.action`	`created`	required
`github.event.check_run`	object or null	optional
`github.event.check_run.completed_at`	string or null	required
`github.event.check_run.conclusion`	`success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required`, `stale`, `skipped`, `None`	required	The result of the completed check run. This value will be `null` until the check run has completed.
`github.event.check_run.details_url`	string	required
`github.event.check_run.external_id`	string	required
`github.event.check_run.head_sha`	string	required	The SHA of the commit that is being checked.
`github.event.check_run.html_url`	string	required
`github.event.check_run.id`	integer	required	The id of the check.
`github.event.check_run.name`	string	required	The name of the check run.
`github.event.check_run.node_id`	string	required
`github.event.check_run.started_at`	string	required
`github.event.check_run.status`	`queued`, `in_progress`, `completed`, `waiting`, `pending`	required	The current status of the check run. Can be `queued`, `in_progress`, or `completed`.
`github.event.check_run.url`	string	required
`github.event.deployment`	object	required	The deployment.
`github.event.deployment.created_at`	string	required
`github.event.deployment.creator`	object or null	required
`github.event.deployment.creator.avatar_url`	string	optional
`github.event.deployment.creator.deleted`	boolean	optional
`github.event.deployment.creator.email`	string or null	optional
`github.event.deployment.creator.events_url`	string	optional
`github.event.deployment.creator.followers_url`	string	optional
`github.event.deployment.creator.following_url`	string	optional
`github.event.deployment.creator.gists_url`	string	optional
`github.event.deployment.creator.gravatar_id`	string	optional
`github.event.deployment.creator.html_url`	string	optional
`github.event.deployment.creator.id`	integer	required
`github.event.deployment.creator.login`	string	required
`github.event.deployment.creator.name`	string	optional
`github.event.deployment.creator.node_id`	string	optional
`github.event.deployment.creator.organizations_url`	string	optional
`github.event.deployment.creator.received_events_url`	string	optional
`github.event.deployment.creator.repos_url`	string	optional
`github.event.deployment.creator.site_admin`	boolean	optional
`github.event.deployment.creator.starred_url`	string	optional
`github.event.deployment.creator.subscriptions_url`	string	optional
`github.event.deployment.creator.type`	`Bot`, `User`, `Organization`	optional
`github.event.deployment.creator.url`	string	optional
`github.event.deployment.description`	string or null	required
`github.event.deployment.environment`	string	required
`github.event.deployment.id`	integer	required
`github.event.deployment.node_id`	string	required
`github.event.deployment.original_environment`	string	required
`github.event.deployment.payload`	null or string or object	required
`github.event.deployment.performed_via_github_app`	object or null	optional	GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
`github.event.deployment.performed_via_github_app.created_at`	string or null	required
`github.event.deployment.performed_via_github_app.description`	string or null	required
`github.event.deployment.performed_via_github_app.events`	array of strings	optional	The list of events for the GitHub app Supported values are: `branch_protection_rule`, `check_run`, `check_suite`, `code_scanning_alert`, `commit_comment`, `content_reference`, `create`, `delete`, `deployment`, `deployment_review`, `deployment_status`, `deploy_key`, `discussion`, `discussion_comment`, `fork`, `gollum`, `issues`, `issue_comment`, `label`, `member`, `membership`, `milestone`, `organization`, `org_block`, `page_build`, `project`, `project_card`, `project_column`, `public`, `pull_request`, `pull_request_review`, `pull_request_review_comment`, `push`, `registry_package`, `release`, `repository`, `repository_dispatch`, `secret_scanning_alert`, `star`, `status`, `team`, `team_add`, `watch`, `workflow_dispatch`, `workflow_run`, `merge_queue_entry`, `workflow_job`, `pull_request_review_thread`, `secret_scanning_alert_location`, `merge_group`
`github.event.deployment.performed_via_github_app.external_url`	string or null	required
`github.event.deployment.performed_via_github_app.html_url`	string	required
`github.event.deployment.performed_via_github_app.id`	integer or null	required	Unique identifier of the GitHub app
`github.event.deployment.performed_via_github_app.name`	string	required	The name of the GitHub app
`github.event.deployment.performed_via_github_app.node_id`	string	required
`github.event.deployment.performed_via_github_app.owner`	object or null	required
`github.event.deployment.performed_via_github_app.owner.avatar_url`	string	optional
`github.event.deployment.performed_via_github_app.owner.deleted`	boolean	optional
`github.event.deployment.performed_via_github_app.owner.email`	string or null	optional
`github.event.deployment.performed_via_github_app.owner.events_url`	string	optional
`github.event.deployment.performed_via_github_app.owner.followers_url`	string	optional
`github.event.deployment.performed_via_github_app.owner.following_url`	string	optional
`github.event.deployment.performed_via_github_app.owner.gists_url`	string	optional
`github.event.deployment.performed_via_github_app.owner.gravatar_id`	string	optional
`github.event.deployment.performed_via_github_app.owner.html_url`	string	optional
`github.event.deployment.performed_via_github_app.owner.id`	integer	required
`github.event.deployment.performed_via_github_app.owner.login`	string	required
`github.event.deployment.performed_via_github_app.owner.name`	string	optional
`github.event.deployment.performed_via_github_app.owner.node_id`	string	optional
`github.event.deployment.performed_via_github_app.owner.organizations_url`	string	optional
`github.event.deployment.performed_via_github_app.owner.received_events_url`	string	optional
`github.event.deployment.performed_via_github_app.owner.repos_url`	string	optional
`github.event.deployment.performed_via_github_app.owner.site_admin`	boolean	optional
`github.event.deployment.performed_via_github_app.owner.starred_url`	string	optional
`github.event.deployment.performed_via_github_app.owner.subscriptions_url`	string	optional
`github.event.deployment.performed_via_github_app.owner.type`	`Bot`, `User`, `Organization`	optional
`github.event.deployment.performed_via_github_app.owner.url`	string	optional
`github.event.deployment.performed_via_github_app.permissions`	object	optional	The set of permissions for the GitHub app
`github.event.deployment.performed_via_github_app.permissions.actions`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.administration`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.checks`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.content_references`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.contents`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.deployments`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.discussions`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.emails`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.environments`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.issues`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.keys`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.members`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.metadata`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.organization_administration`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.organization_hooks`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.organization_packages`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.organization_plan`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.organization_projects`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.organization_secrets`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.organization_self_hosted_runners`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.organization_user_blocking`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.packages`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.pages`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.pull_requests`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.repository_hooks`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.repository_projects`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.secret_scanning_alerts`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.secrets`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.security_events`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.security_scanning_alert`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.single_file`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.statuses`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.team_discussions`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.vulnerability_alerts`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.permissions.workflows`	`read`, `write`	optional
`github.event.deployment.performed_via_github_app.slug`	string	optional	The slug name of the GitHub app
`github.event.deployment.performed_via_github_app.updated_at`	string or null	required
`github.event.deployment.production_environment`	boolean	optional
`github.event.deployment.ref`	string	required
`github.event.deployment.repository_url`	string	required
`github.event.deployment.sha`	string	required
`github.event.deployment.statuses_url`	string	required
`github.event.deployment.task`	string	required
`github.event.deployment.transient_environment`	boolean	optional
`github.event.deployment.updated_at`	string	required
`github.event.deployment.url`	string	required
`github.event.deployment_status`	object	required	The deployment status.
`github.event.deployment_status.created_at`	string	required
`github.event.deployment_status.creator`	object or null	required
`github.event.deployment_status.creator.avatar_url`	string	optional
`github.event.deployment_status.creator.deleted`	boolean	optional
`github.event.deployment_status.creator.email`	string or null	optional
`github.event.deployment_status.creator.events_url`	string	optional
`github.event.deployment_status.creator.followers_url`	string	optional
`github.event.deployment_status.creator.following_url`	string	optional
`github.event.deployment_status.creator.gists_url`	string	optional
`github.event.deployment_status.creator.gravatar_id`	string	optional
`github.event.deployment_status.creator.html_url`	string	optional
`github.event.deployment_status.creator.id`	integer	required
`github.event.deployment_status.creator.login`	string	required
`github.event.deployment_status.creator.name`	string	optional
`github.event.deployment_status.creator.node_id`	string	optional
`github.event.deployment_status.creator.organizations_url`	string	optional
`github.event.deployment_status.creator.received_events_url`	string	optional
`github.event.deployment_status.creator.repos_url`	string	optional
`github.event.deployment_status.creator.site_admin`	boolean	optional
`github.event.deployment_status.creator.starred_url`	string	optional
`github.event.deployment_status.creator.subscriptions_url`	string	optional
`github.event.deployment_status.creator.type`	`Bot`, `User`, `Organization`	optional
`github.event.deployment_status.creator.url`	string	optional
`github.event.deployment_status.deployment_url`	string	required
`github.event.deployment_status.description`	string	required	The optional human-readable description added to the status.
`github.event.deployment_status.environment`	string	required
`github.event.deployment_status.environment_url`	string	optional
`github.event.deployment_status.id`	integer	required
`github.event.deployment_status.log_url`	string	optional
`github.event.deployment_status.node_id`	string	required
`github.event.deployment_status.performed_via_github_app`	object or null	optional	GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
`github.event.deployment_status.performed_via_github_app.created_at`	string or null	required
`github.event.deployment_status.performed_via_github_app.description`	string or null	required
`github.event.deployment_status.performed_via_github_app.events`	array of strings	optional	The list of events for the GitHub app Supported values are: `branch_protection_rule`, `check_run`, `check_suite`, `code_scanning_alert`, `commit_comment`, `content_reference`, `create`, `delete`, `deployment`, `deployment_review`, `deployment_status`, `deploy_key`, `discussion`, `discussion_comment`, `fork`, `gollum`, `issues`, `issue_comment`, `label`, `member`, `membership`, `milestone`, `organization`, `org_block`, `page_build`, `project`, `project_card`, `project_column`, `public`, `pull_request`, `pull_request_review`, `pull_request_review_comment`, `push`, `registry_package`, `release`, `repository`, `repository_dispatch`, `secret_scanning_alert`, `star`, `status`, `team`, `team_add`, `watch`, `workflow_dispatch`, `workflow_run`, `pull_request_review_thread`, `merge_queue_entry`, `workflow_job`, `merge_group`, `secret_scanning_alert_location`
`github.event.deployment_status.performed_via_github_app.external_url`	string or null	required
`github.event.deployment_status.performed_via_github_app.html_url`	string	required
`github.event.deployment_status.performed_via_github_app.id`	integer or null	required	Unique identifier of the GitHub app
`github.event.deployment_status.performed_via_github_app.name`	string	required	The name of the GitHub app
`github.event.deployment_status.performed_via_github_app.node_id`	string	required
`github.event.deployment_status.performed_via_github_app.owner`	object or null	required
`github.event.deployment_status.performed_via_github_app.owner.avatar_url`	string	optional
`github.event.deployment_status.performed_via_github_app.owner.deleted`	boolean	optional
`github.event.deployment_status.performed_via_github_app.owner.email`	string or null	optional
`github.event.deployment_status.performed_via_github_app.owner.events_url`	string	optional
`github.event.deployment_status.performed_via_github_app.owner.followers_url`	string	optional
`github.event.deployment_status.performed_via_github_app.owner.following_url`	string	optional
`github.event.deployment_status.performed_via_github_app.owner.gists_url`	string	optional
`github.event.deployment_status.performed_via_github_app.owner.gravatar_id`	string	optional
`github.event.deployment_status.performed_via_github_app.owner.html_url`	string	optional
`github.event.deployment_status.performed_via_github_app.owner.id`	integer	required
`github.event.deployment_status.performed_via_github_app.owner.login`	string	required
`github.event.deployment_status.performed_via_github_app.owner.name`	string	optional
`github.event.deployment_status.performed_via_github_app.owner.node_id`	string	optional
`github.event.deployment_status.performed_via_github_app.owner.organizations_url`	string	optional
`github.event.deployment_status.performed_via_github_app.owner.received_events_url`	string	optional
`github.event.deployment_status.performed_via_github_app.owner.repos_url`	string	optional
`github.event.deployment_status.performed_via_github_app.owner.site_admin`	boolean	optional
`github.event.deployment_status.performed_via_github_app.owner.starred_url`	string	optional
`github.event.deployment_status.performed_via_github_app.owner.subscriptions_url`	string	optional
`github.event.deployment_status.performed_via_github_app.owner.type`	`Bot`, `User`, `Organization`	optional
`github.event.deployment_status.performed_via_github_app.owner.url`	string	optional
`github.event.deployment_status.performed_via_github_app.permissions`	object	optional	The set of permissions for the GitHub app
`github.event.deployment_status.performed_via_github_app.permissions.actions`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.administration`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.checks`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.content_references`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.contents`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.deployments`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.discussions`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.emails`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.environments`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.issues`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.keys`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.members`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.metadata`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.organization_administration`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.organization_hooks`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.organization_packages`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.organization_plan`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.organization_projects`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.organization_secrets`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.organization_self_hosted_runners`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.organization_user_blocking`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.packages`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.pages`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.pull_requests`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.repository_hooks`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.repository_projects`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.secret_scanning_alerts`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.secrets`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.security_events`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.security_scanning_alert`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.single_file`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.statuses`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.team_discussions`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.vulnerability_alerts`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.permissions.workflows`	`read`, `write`	optional
`github.event.deployment_status.performed_via_github_app.slug`	string	optional	The slug name of the GitHub app
`github.event.deployment_status.performed_via_github_app.updated_at`	string or null	required
`github.event.deployment_status.repository_url`	string	required
`github.event.deployment_status.state`	string	required	The new state. Can be `pending`, `success`, `failure`, or `error`.
`github.event.deployment_status.target_url`	string	required	The optional link added to the status.
`github.event.deployment_status.updated_at`	string	required
`github.event.deployment_status.url`	string	required
`github.event.enterprise`	object	optional	An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured on an enterprise account or an organization that’s part of an enterprise account. For more information, see “About enterprise accounts."
`github.event.installation`	object	optional	The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."
`github.event.organization`	object	optional	A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.
`github.event.repository`	object	required	The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository.
`github.event.sender`	object	required	The GitHub user that triggered the event. This property is included in every webhook payload.
`github.event.workflow`	object or null	optional
`github.event.workflow.badge_url`	string	required
`github.event.workflow.created_at`	string	required
`github.event.workflow.html_url`	string	required
`github.event.workflow.id`	integer	required
`github.event.workflow.name`	string	required
`github.event.workflow.node_id`	string	required
`github.event.workflow.path`	string	required
`github.event.workflow.state`	string	required
`github.event.workflow.updated_at`	string	required
`github.event.workflow.url`	string	required
`github.event.workflow_run`	object or null	optional
`github.event.workflow_run.actor`	object or null	required
`github.event.workflow_run.actor.avatar_url`	string	optional
`github.event.workflow_run.actor.deleted`	boolean	optional
`github.event.workflow_run.actor.email`	string or null	optional
`github.event.workflow_run.actor.events_url`	string	optional
`github.event.workflow_run.actor.followers_url`	string	optional
`github.event.workflow_run.actor.following_url`	string	optional
`github.event.workflow_run.actor.gists_url`	string	optional
`github.event.workflow_run.actor.gravatar_id`	string	optional
`github.event.workflow_run.actor.html_url`	string	optional
`github.event.workflow_run.actor.id`	integer	required
`github.event.workflow_run.actor.login`	string	required
`github.event.workflow_run.actor.name`	string	optional
`github.event.workflow_run.actor.node_id`	string	optional
`github.event.workflow_run.actor.organizations_url`	string	optional
`github.event.workflow_run.actor.received_events_url`	string	optional
`github.event.workflow_run.actor.repos_url`	string	optional
`github.event.workflow_run.actor.site_admin`	boolean	optional
`github.event.workflow_run.actor.starred_url`	string	optional
`github.event.workflow_run.actor.subscriptions_url`	string	optional
`github.event.workflow_run.actor.type`	`Bot`, `User`, `Organization`	optional
`github.event.workflow_run.actor.url`	string	optional
`github.event.workflow_run.artifacts_url`	string	optional
`github.event.workflow_run.cancel_url`	string	optional
`github.event.workflow_run.check_suite_id`	integer	required
`github.event.workflow_run.check_suite_node_id`	string	required
`github.event.workflow_run.check_suite_url`	string	optional
`github.event.workflow_run.conclusion`	`success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required`, `stale`, `None`, `startup_failure`	required
`github.event.workflow_run.created_at`	string	required
`github.event.workflow_run.display_title`	string	required
`github.event.workflow_run.event`	string	required
`github.event.workflow_run.head_branch`	string	required
`github.event.workflow_run.head_commit`	null	optional
`github.event.workflow_run.head_repository`	object	optional
`github.event.workflow_run.head_repository.archive_url`	string	optional
`github.event.workflow_run.head_repository.assignees_url`	string	optional
`github.event.workflow_run.head_repository.blobs_url`	string	optional
`github.event.workflow_run.head_repository.branches_url`	string	optional
`github.event.workflow_run.head_repository.collaborators_url`	string	optional
`github.event.workflow_run.head_repository.comments_url`	string	optional
`github.event.workflow_run.head_repository.commits_url`	string	optional
`github.event.workflow_run.head_repository.compare_url`	string	optional
`github.event.workflow_run.head_repository.contents_url`	string	optional
`github.event.workflow_run.head_repository.contributors_url`	string	optional
`github.event.workflow_run.head_repository.deployments_url`	string	optional
`github.event.workflow_run.head_repository.description`	null	optional
`github.event.workflow_run.head_repository.downloads_url`	string	optional
`github.event.workflow_run.head_repository.events_url`	string	optional
`github.event.workflow_run.head_repository.fork`	boolean	optional
`github.event.workflow_run.head_repository.forks_url`	string	optional
`github.event.workflow_run.head_repository.full_name`	string	optional
`github.event.workflow_run.head_repository.git_commits_url`	string	optional
`github.event.workflow_run.head_repository.git_refs_url`	string	optional
`github.event.workflow_run.head_repository.git_tags_url`	string	optional
`github.event.workflow_run.head_repository.hooks_url`	string	optional
`github.event.workflow_run.head_repository.html_url`	string	optional
`github.event.workflow_run.head_repository.id`	integer	optional
`github.event.workflow_run.head_repository.issue_comment_url`	string	optional
`github.event.workflow_run.head_repository.issue_events_url`	string	optional
`github.event.workflow_run.head_repository.issues_url`	string	optional
`github.event.workflow_run.head_repository.keys_url`	string	optional
`github.event.workflow_run.head_repository.labels_url`	string	optional
`github.event.workflow_run.head_repository.languages_url`	string	optional
`github.event.workflow_run.head_repository.merges_url`	string	optional
`github.event.workflow_run.head_repository.milestones_url`	string	optional
`github.event.workflow_run.head_repository.name`	string	optional
`github.event.workflow_run.head_repository.node_id`	string	optional
`github.event.workflow_run.head_repository.notifications_url`	string	optional
`github.event.workflow_run.head_repository.owner`	object	optional
`github.event.workflow_run.head_repository.owner.avatar_url`	string	optional
`github.event.workflow_run.head_repository.owner.events_url`	string	optional
`github.event.workflow_run.head_repository.owner.followers_url`	string	optional
`github.event.workflow_run.head_repository.owner.following_url`	string	optional
`github.event.workflow_run.head_repository.owner.gists_url`	string	optional
`github.event.workflow_run.head_repository.owner.gravatar_id`	string	optional
`github.event.workflow_run.head_repository.owner.html_url`	string	optional
`github.event.workflow_run.head_repository.owner.id`	integer	optional
`github.event.workflow_run.head_repository.owner.login`	string	optional
`github.event.workflow_run.head_repository.owner.node_id`	string	optional
`github.event.workflow_run.head_repository.owner.organizations_url`	string	optional
`github.event.workflow_run.head_repository.owner.received_events_url`	string	optional
`github.event.workflow_run.head_repository.owner.repos_url`	string	optional
`github.event.workflow_run.head_repository.owner.site_admin`	boolean	optional
`github.event.workflow_run.head_repository.owner.starred_url`	string	optional
`github.event.workflow_run.head_repository.owner.subscriptions_url`	string	optional
`github.event.workflow_run.head_repository.owner.type`	string	optional
`github.event.workflow_run.head_repository.owner.url`	string	optional
`github.event.workflow_run.head_repository.private`	boolean	optional
`github.event.workflow_run.head_repository.pulls_url`	string	optional
`github.event.workflow_run.head_repository.releases_url`	string	optional
`github.event.workflow_run.head_repository.stargazers_url`	string	optional
`github.event.workflow_run.head_repository.statuses_url`	string	optional
`github.event.workflow_run.head_repository.subscribers_url`	string	optional
`github.event.workflow_run.head_repository.subscription_url`	string	optional
`github.event.workflow_run.head_repository.tags_url`	string	optional
`github.event.workflow_run.head_repository.teams_url`	string	optional
`github.event.workflow_run.head_repository.trees_url`	string	optional
`github.event.workflow_run.head_repository.url`	string	optional
`github.event.workflow_run.head_sha`	string	required
`github.event.workflow_run.html_url`	string	required
`github.event.workflow_run.id`	integer	required
`github.event.workflow_run.jobs_url`	string	optional
`github.event.workflow_run.logs_url`	string	optional
`github.event.workflow_run.name`	string	required
`github.event.workflow_run.node_id`	string	required
`github.event.workflow_run.path`	string	required
`github.event.workflow_run.previous_attempt_url`	null	optional
`github.event.workflow_run.pull_requests`	array of objects	required
`github.event.workflow_run.pull_requests.base`	object	required
`github.event.workflow_run.pull_requests.base.ref`	string	required
`github.event.workflow_run.pull_requests.base.repo`	object	required
`github.event.workflow_run.pull_requests.base.repo.id`	integer	required
`github.event.workflow_run.pull_requests.base.repo.name`	string	required
`github.event.workflow_run.pull_requests.base.repo.url`	string	required
`github.event.workflow_run.pull_requests.base.sha`	string	required
`github.event.workflow_run.pull_requests.head`	object	required
`github.event.workflow_run.pull_requests.head.ref`	string	required
`github.event.workflow_run.pull_requests.head.repo`	object	required
`github.event.workflow_run.pull_requests.head.repo.id`	integer	required
`github.event.workflow_run.pull_requests.head.repo.name`	string	required
`github.event.workflow_run.pull_requests.head.repo.url`	string	required
`github.event.workflow_run.pull_requests.head.sha`	string	required
`github.event.workflow_run.pull_requests.id`	integer	required
`github.event.workflow_run.pull_requests.number`	integer	required
`github.event.workflow_run.pull_requests.url`	string	required
`github.event.workflow_run.referenced_workflows`	array of objects or null	optional
`github.event.workflow_run.referenced_workflows.path`	string	required
`github.event.workflow_run.referenced_workflows.ref`	string	optional
`github.event.workflow_run.referenced_workflows.sha`	string	required
`github.event.workflow_run.repository`	object	optional
`github.event.workflow_run.repository.archive_url`	string	optional
`github.event.workflow_run.repository.assignees_url`	string	optional
`github.event.workflow_run.repository.blobs_url`	string	optional
`github.event.workflow_run.repository.branches_url`	string	optional
`github.event.workflow_run.repository.collaborators_url`	string	optional
`github.event.workflow_run.repository.comments_url`	string	optional
`github.event.workflow_run.repository.commits_url`	string	optional
`github.event.workflow_run.repository.compare_url`	string	optional
`github.event.workflow_run.repository.contents_url`	string	optional
`github.event.workflow_run.repository.contributors_url`	string	optional
`github.event.workflow_run.repository.deployments_url`	string	optional
`github.event.workflow_run.repository.description`	null	optional
`github.event.workflow_run.repository.downloads_url`	string	optional
`github.event.workflow_run.repository.events_url`	string	optional
`github.event.workflow_run.repository.fork`	boolean	optional
`github.event.workflow_run.repository.forks_url`	string	optional
`github.event.workflow_run.repository.full_name`	string	optional
`github.event.workflow_run.repository.git_commits_url`	string	optional
`github.event.workflow_run.repository.git_refs_url`	string	optional
`github.event.workflow_run.repository.git_tags_url`	string	optional
`github.event.workflow_run.repository.hooks_url`	string	optional
`github.event.workflow_run.repository.html_url`	string	optional
`github.event.workflow_run.repository.id`	integer	optional
`github.event.workflow_run.repository.issue_comment_url`	string	optional
`github.event.workflow_run.repository.issue_events_url`	string	optional
`github.event.workflow_run.repository.issues_url`	string	optional
`github.event.workflow_run.repository.keys_url`	string	optional
`github.event.workflow_run.repository.labels_url`	string	optional
`github.event.workflow_run.repository.languages_url`	string	optional
`github.event.workflow_run.repository.merges_url`	string	optional
`github.event.workflow_run.repository.milestones_url`	string	optional
`github.event.workflow_run.repository.name`	string	optional
`github.event.workflow_run.repository.node_id`	string	optional
`github.event.workflow_run.repository.notifications_url`	string	optional
`github.event.workflow_run.repository.owner`	object	optional
`github.event.workflow_run.repository.owner.avatar_url`	string	optional
`github.event.workflow_run.repository.owner.events_url`	string	optional
`github.event.workflow_run.repository.owner.followers_url`	string	optional
`github.event.workflow_run.repository.owner.following_url`	string	optional
`github.event.workflow_run.repository.owner.gists_url`	string	optional
`github.event.workflow_run.repository.owner.gravatar_id`	string	optional
`github.event.workflow_run.repository.owner.html_url`	string	optional
`github.event.workflow_run.repository.owner.id`	integer	optional
`github.event.workflow_run.repository.owner.login`	string	optional
`github.event.workflow_run.repository.owner.node_id`	string	optional
`github.event.workflow_run.repository.owner.organizations_url`	string	optional
`github.event.workflow_run.repository.owner.received_events_url`	string	optional
`github.event.workflow_run.repository.owner.repos_url`	string	optional
`github.event.workflow_run.repository.owner.site_admin`	boolean	optional
`github.event.workflow_run.repository.owner.starred_url`	string	optional
`github.event.workflow_run.repository.owner.subscriptions_url`	string	optional
`github.event.workflow_run.repository.owner.type`	string	optional
`github.event.workflow_run.repository.owner.url`	string	optional
`github.event.workflow_run.repository.private`	boolean	optional
`github.event.workflow_run.repository.pulls_url`	string	optional
`github.event.workflow_run.repository.releases_url`	string	optional
`github.event.workflow_run.repository.stargazers_url`	string	optional
`github.event.workflow_run.repository.statuses_url`	string	optional
`github.event.workflow_run.repository.subscribers_url`	string	optional
`github.event.workflow_run.repository.subscription_url`	string	optional
`github.event.workflow_run.repository.tags_url`	string	optional
`github.event.workflow_run.repository.teams_url`	string	optional
`github.event.workflow_run.repository.trees_url`	string	optional
`github.event.workflow_run.repository.url`	string	optional
`github.event.workflow_run.rerun_url`	string	optional
`github.event.workflow_run.run_attempt`	integer	required
`github.event.workflow_run.run_number`	integer	required
`github.event.workflow_run.run_started_at`	string	required
`github.event.workflow_run.status`	`requested`, `in_progress`, `completed`, `queued`, `waiting`, `pending`	required
`github.event.workflow_run.triggering_actor`	object or null	required
`github.event.workflow_run.triggering_actor.avatar_url`	string	optional
`github.event.workflow_run.triggering_actor.deleted`	boolean	optional
`github.event.workflow_run.triggering_actor.email`	string or null	optional
`github.event.workflow_run.triggering_actor.events_url`	string	optional
`github.event.workflow_run.triggering_actor.followers_url`	string	optional
`github.event.workflow_run.triggering_actor.following_url`	string	optional
`github.event.workflow_run.triggering_actor.gists_url`	string	optional
`github.event.workflow_run.triggering_actor.gravatar_id`	string	optional
`github.event.workflow_run.triggering_actor.html_url`	string	optional
`github.event.workflow_run.triggering_actor.id`	integer	required
`github.event.workflow_run.triggering_actor.login`	string	required
`github.event.workflow_run.triggering_actor.name`	string	optional
`github.event.workflow_run.triggering_actor.node_id`	string	optional
`github.event.workflow_run.triggering_actor.organizations_url`	string	optional
`github.event.workflow_run.triggering_actor.received_events_url`	string	optional
`github.event.workflow_run.triggering_actor.repos_url`	string	optional
`github.event.workflow_run.triggering_actor.site_admin`	boolean	optional
`github.event.workflow_run.triggering_actor.starred_url`	string	optional
`github.event.workflow_run.triggering_actor.subscriptions_url`	string	optional
`github.event.workflow_run.triggering_actor.type`	`Bot`, `User`, `Organization`	optional
`github.event.workflow_run.triggering_actor.url`	string	optional
`github.event.workflow_run.updated_at`	string	required
`github.event.workflow_run.url`	string	required
`github.event.workflow_run.workflow_id`	integer	required
`github.event.workflow_run.workflow_url`	string	optional

`created` #

This event occurs when there is activity relating to deployment statuses. For more information, see "About deployments." For information about the APIs to manage deployments, see the GraphQL API documentation or "Deployments" in the REST API documentation.

For activity relating to deployment creation, use the deployment event.

To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.

field	type	required	description

Github Event deployment_status #

Github Action Trigger #

Event Payload #

Common Fields #

created #

Github Event `deployment_status` #

`created` #