Properties
| Name | Type | Description |
|---|---|---|
| action | string | |
| deployment | object | The [deployment](https://docs.github.com/[email protected]/rest/deployments/deployments#list-deployments). |
| enterprise | object | |
| installation | object | |
| organization | object | |
| repository | object | |
| sender | object | |
| workflow | object | |
| workflow_run | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/webhook-deployment-created",
"title": "deployment created event",
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"created"
]
},
"deployment": {
"title": "Deployment",
"description": "The [deployment](https://docs.github.com/[email protected]/rest/deployments/deployments#list-deployments).",
"type": "object",
"properties": {
"created_at": {
"type": "string"
},
"creator": {
"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"
}
},
"required": [
"login",
"id"
]
},
"description": {
"type": "string",
"nullable": true
},
"environment": {
"type": "string"
},
"id": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"original_environment": {
"type": "string"
},
"payload": {
"oneOf": [
{
"type": "object"
},
{
"type": "string"
}
]
},
"performed_via_github_app": {
"title": "App",
"description": "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.",
"type": "object",
"nullable": true,
"properties": {
"created_at": {
"type": "string",
"nullable": true,
"format": "date-time"
},
"description": {
"type": "string",
"nullable": true
},
"events": {
"description": "The list of events for the GitHub app",
"type": "array",
"items": {
"type": "string",
"enum": [
"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",
"workflow_job",
"pull_request_review_thread",
"merge_queue_entry",
"secret_scanning_alert_location",
"merge_group"
]
}
},
"external_url": {
"type": "string",
"nullable": true,
"format": "uri"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"description": "Unique identifier of the GitHub app",
"type": "integer",
"nullable": true
},
"name": {
"description": "The name of the GitHub app",
"type": "string"
},
"node_id": {
"type": "string"
},
"owner": {
"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"
}
},
"required": [
"login",
"id"
]
},
"permissions": {
"description": "The set of permissions for the GitHub app",
"type": "object",
"properties": {
"actions": {
"type": "string",
"enum": [
"read",
"write"
]
},
"administration": {
"type": "string",
"enum": [
"read",
"write"
]
},
"checks": {
"type": "string",
"enum": [
"read",
"write"
]
},
"content_references": {
"type": "string",
"enum": [
"read",
"write"
]
},
"contents": {
"type": "string",
"enum": [
"read",
"write"
]
},
"deployments": {
"type": "string",
"enum": [
"read",
"write"
]
},
"discussions": {
"type": "string",
"enum": [
"read",
"write"
]
},
"emails": {
"type": "string",
"enum": [
"read",
"write"
]
},
"environments": {
"type": "string",
"enum": [
"read",
"write"
]
},
"issues": {
"type": "string",
"enum": [
"read",
"write"
]
},
"keys": {
"type": "string",
"enum": [
"read",
"write"
]
},
"members": {
"type": "string",
"enum": [
"read",
"write"
]
},
"metadata": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_administration": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_hooks": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_packages": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_plan": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_projects": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_secrets": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_self_hosted_runners": {
"type": "string",
"enum": [
"read",
"write"
]
},
"organization_user_blocking": {
"type": "string",
"enum": [
"read",
"write"
]
},
"packages": {
"type": "string",
"enum": [
"read",
"write"
]
},
"pages": {
"type": "string",
"enum": [
"read",
"write"
]
},
"pull_requests": {
"type": "string",
"enum": [
"read",
"write"
]
},
"repository_hooks": {
"type": "string",
"enum": [
"read",
"write"
]
},
"repository_projects": {
"type": "string",
"enum": [
"read",
"write"
]
},
"secret_scanning_alerts": {
"type": "string",
"enum": [
"read",
"write"
]
},
"secrets": {
"type": "string",
"enum": [
"read",
"write"
]
},
"security_events": {
"type": "string",
"enum": [
"read",
"write"
]
},
"security_scanning_alert": {
"type": "string",
"enum": [
"read",
"write"
]
},
"single_file": {
"type": "string",
"enum": [
"read",
"write"
]
},
"statuses": {
"type": "string",
"enum": [
"read",
"write"
]
},
"team_discussions": {
"type": "string",
"enum": [
"read",
"write"
]
},
"vulnerability_alerts": {
"type": "string",
"enum": [
"read",
"write"
]
},
"workflows": {
"type": "string",
"enum": [
"read",
"write"
]
}
}
},
"slug": {
"description": "The slug name of the GitHub app",
"type": "string"
},
"updated_at": {
"type": "string",
"nullable": true,
"format": "date-time"
}
},
"required": [
"id",
"node_id",
"owner",
"name",
"description",
"external_url",
"html_url",
"created_at",
"updated_at"
]
},
"production_environment": {
"type": "boolean"
},
"ref": {
"type": "string"
},
"repository_url": {
"type": "string",
"format": "uri"
},
"sha": {
"type": "string"
},
"statuses_url": {
"type": "string",
"format": "uri"
},
"task": {
"type": "string"
},
"transient_environment": {
"type": "boolean"
},
"updated_at": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"url",
"id",
"node_id",
"sha",
"ref",
"task",
"payload",
"original_environment",
"environment",
"description",
"creator",
"created_at",
"updated_at",
"statuses_url",
"repository_url"
]
},
"enterprise": {
"$ref": "#/components/schemas/enterprise-webhooks"
},
"installation": {
"$ref": "#/components/schemas/simple-installation"
},
"organization": {
"$ref": "#/components/schemas/organization-simple-webhooks"
},
"repository": {
"$ref": "#/components/schemas/repository-webhooks"
},
"sender": {
"$ref": "#/components/schemas/simple-user-webhooks"
},
"workflow": {
"$ref": "#/components/schemas/webhooks_workflow"
},
"workflow_run": {
"title": "Deployment Workflow Run",
"type": "object",
"nullable": true,
"properties": {
"actor": {
"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"
}
},
"required": [
"login",
"id"
]
},
"artifacts_url": {
"type": "string"
},
"cancel_url": {
"type": "string"
},
"check_suite_id": {
"type": "integer"
},
"check_suite_node_id": {
"type": "string"
},
"check_suite_url": {
"type": "string"
},
"conclusion": {
"type": "string",
"nullable": true,
"enum": [
"success",
"failure",
"neutral",
"cancelled",
"timed_out",
"action_required",
"stale",
null
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"display_title": {
"type": "string"
},
"event": {
"type": "string"
},
"head_branch": {
"type": "string"
},
"head_commit": {
"nullable": true
},
"head_repository": {
"type": "object",
"properties": {
"archive_url": {
"type": "string"
},
"assignees_url": {
"type": "string"
},
"blobs_url": {
"type": "string"
},
"branches_url": {
"type": "string"
},
"collaborators_url": {
"type": "string"
},
"comments_url": {
"type": "string"
},
"commits_url": {
"type": "string"
},
"compare_url": {
"type": "string"
},
"contents_url": {
"type": "string"
},
"contributors_url": {
"type": "string"
},
"deployments_url": {
"type": "string"
},
"description": {
"nullable": true
},
"downloads_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"fork": {
"type": "boolean"
},
"forks_url": {
"type": "string"
},
"full_name": {
"type": "string"
},
"git_commits_url": {
"type": "string"
},
"git_refs_url": {
"type": "string"
},
"git_tags_url": {
"type": "string"
},
"hooks_url": {
"type": "string"
},
"html_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"issue_comment_url": {
"type": "string"
},
"issue_events_url": {
"type": "string"
},
"issues_url": {
"type": "string"
},
"keys_url": {
"type": "string"
},
"labels_url": {
"type": "string"
},
"languages_url": {
"type": "string"
},
"merges_url": {
"type": "string"
},
"milestones_url": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"notifications_url": {
"type": "string"
},
"owner": {
"type": "object",
"properties": {
"avatar_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"followers_url": {
"type": "string"
},
"following_url": {
"type": "string"
},
"gists_url": {
"type": "string"
},
"gravatar_id": {
"type": "string"
},
"html_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"login": {
"type": "string"
},
"node_id": {
"type": "string"
},
"organizations_url": {
"type": "string"
},
"received_events_url": {
"type": "string"
},
"repos_url": {
"type": "string"
},
"site_admin": {
"type": "boolean"
},
"starred_url": {
"type": "string"
},
"subscriptions_url": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"private": {
"type": "boolean"
},
"pulls_url": {
"type": "string"
},
"releases_url": {
"type": "string"
},
"stargazers_url": {
"type": "string"
},
"statuses_url": {
"type": "string"
},
"subscribers_url": {
"type": "string"
},
"subscription_url": {
"type": "string"
},
"tags_url": {
"type": "string"
},
"teams_url": {
"type": "string"
},
"trees_url": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"head_sha": {
"type": "string"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer"
},
"jobs_url": {
"type": "string"
},
"logs_url": {
"type": "string"
},
"name": {
"type": "string"
},
"node_id": {
"type": "string"
},
"path": {
"type": "string"
},
"previous_attempt_url": {
"nullable": true
},
"pull_requests": {
"type": "array",
"items": {
"title": "Check Run Pull Request",
"type": "object",
"properties": {
"base": {
"type": "object",
"properties": {
"ref": {
"type": "string"
},
"repo": {
"title": "Repo Ref",
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"url",
"name"
]
},
"sha": {
"type": "string"
}
},
"required": [
"ref",
"sha",
"repo"
]
},
"head": {
"type": "object",
"properties": {
"ref": {
"type": "string"
},
"repo": {
"title": "Repo Ref",
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"url",
"name"
]
},
"sha": {
"type": "string"
}
},
"required": [
"ref",
"sha",
"repo"
]
},
"id": {
"type": "integer"
},
"number": {
"type": "integer"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": [
"url",
"id",
"number",
"head",
"base"
]
}
},
"referenced_workflows": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"ref": {
"type": "string"
},
"sha": {
"type": "string"
}
},
"required": [
"path",
"sha"
]
}
},
"repository": {
"type": "object",
"properties": {
"archive_url": {
"type": "string"
},
"assignees_url": {
"type": "string"
},
"blobs_url": {
"type": "string"
},
"branches_url": {
"type": "string"
},
"collaborators_url": {
"type": "string"
},
"comments_url": {
"type": "string"
},
"commits_url": {
"type": "string"
},
"compare_url": {
"type": "string"
},
"contents_url": {
"type": "string"
},
"contributors_url": {
"type": "string"
},
"deployments_url": {
"type": "string"
},
"description": {
"nullable": true
},
"downloads_url": {
"type": "string"
},
"events_url": {
"type": "string"
},
"fork": {
"type": "boolean"
},
"forks_url": {
"type": "string"
},
"full_name": {
"type": "string"
},
"git_commits_url": {
"type": "string"
},
"git_refs_url": {
"type": "string"
},
"git_tags_url": {
"type": "string"
},
"hooks_url": {
"type": "string"
},
"html_url": {
"type": "string"
},
"id": {
"type": "integer"
},
"issue_comment_url": {
"type": "string"
# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apis-io-engineering-platform/refs/heads/main/json-schema/apis-io-engineering-platform-webhook-deployment-created-schema.json