{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/webhook-workflow-run-completed", "title": "workflow_run completed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ "completed" ] }, "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": "Workflow Run", "type": "object", "required": [ "actor", "artifacts_url", "cancel_url", "check_suite_id", "check_suite_node_id", "check_suite_url", "conclusion", "created_at", "event", "head_branch", "head_commit", "head_repository", "head_sha", "html_url", "id", "jobs_url", "logs_url", "name", "node_id", "path", "previous_attempt_url", "pull_requests", "repository", "rerun_url", "run_attempt", "run_number", "run_started_at", "status", "triggering_actor", "updated_at", "url", "workflow_id", "workflow_url" ], "properties": { "actor": { "title": "User", "type": "object", "nullable": true, "required": [ "login", "id" ], "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" } } }, "artifacts_url": { "type": "string", "format": "uri" }, "cancel_url": { "type": "string", "format": "uri" }, "check_suite_id": { "type": "integer" }, "check_suite_node_id": { "type": "string" }, "check_suite_url": { "type": "string", "format": "uri" }, "conclusion": { "type": "string", "nullable": true, "enum": [ "action_required", "cancelled", "failure", "neutral", "skipped", "stale", "success", "timed_out" ] }, "created_at": { "type": "string", "format": "date-time" }, "event": { "type": "string" }, "head_branch": { "type": "string", "nullable": true }, "head_commit": { "title": "SimpleCommit", "type": "object", "required": [ "id", "tree_id", "message", "timestamp", "author", "committer" ], "properties": { "author": { "title": "Committer", "description": "Metaproperties for Git author/committer information.", "type": "object", "required": [ "email", "name" ], "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" } } }, "committer": { "title": "Committer", "description": "Metaproperties for Git author/committer information.", "type": "object", "required": [ "email", "name" ], "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" } } }, "id": { "type": "string" }, "message": { "type": "string" }, "timestamp": { "type": "string" }, "tree_id": { "type": "string" } } }, "head_repository": { "title": "Repository Lite", "type": "object", "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "node_id", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ], "properties": { "archive_url": { "type": "string", "format": "uri-template" }, "assignees_url": { "type": "string", "format": "uri-template" }, "blobs_url": { "type": "string", "format": "uri-template" }, "branches_url": { "type": "string", "format": "uri-template" }, "collaborators_url": { "type": "string", "format": "uri-template" }, "comments_url": { "type": "string", "format": "uri-template" }, "commits_url": { "type": "string", "format": "uri-template" }, "compare_url": { "type": "string", "format": "uri-template" }, "contents_url": { "type": "string", "format": "uri-template" }, "contributors_url": { "type": "string", "format": "uri" }, "deployments_url": { "type": "string", "format": "uri" }, "description": { "type": "string", "nullable": true }, "downloads_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "fork": { "type": "boolean" }, "forks_url": { "type": "string", "format": "uri" }, "full_name": { "type": "string" }, "git_commits_url": { "type": "string", "format": "uri-template" }, "git_refs_url": { "type": "string", "format": "uri-template" }, "git_tags_url": { "type": "string", "format": "uri-template" }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer" }, "issue_comment_url": { "type": "string", "format": "uri-template" }, "issue_events_url": { "type": "string", "format": "uri-template" }, "issues_url": { "type": "string", "format": "uri-template" }, "keys_url": { "type": "string", "format": "uri-template" }, "labels_url": { "type": "string", "format": "uri-template" }, "languages_url": { "type": "string", "format": "uri" }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "name": { "description": "The name of the repository.", "type": "string" }, "node_id": { "type": "string" }, "notifications_url": { "type": "string", "format": "uri-template" }, "owner": { "title": "User", "type": "object", "nullable": true, "required": [ "login", "id" ], "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" } } }, "private": { "description": "Whether the repository is private or public.", "type": "boolean" }, "pulls_url": { "type": "string", "format": "uri-template" }, "releases_url": { "type": "string", "format": "uri-template" }, "stargazers_url": { "type": "string", "format": "uri" }, "statuses_url": { "type": "string", "format": "uri-template" }, "subscribers_url": { "type": "string", "format": "uri" }, "subscription_url": { "type": "string", "format": "uri" }, "tags_url": { "type": "string", "format": "uri" }, "teams_url": { "type": "string", "format": "uri" }, "trees_url": { "type": "string", "format": "uri-template" }, "url": { "type": "string", "format": "uri" } } }, "head_sha": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "jobs_url": { "type": "string", "format": "uri" }, "logs_url": { "type": "string", "format": "uri" }, "name": { "type": "string", "nullable": true }, "node_id": { "type": "string" }, "path": { "type": "string" }, "previous_attempt_url": { "type": "string", "nullable": true, "format": "uri" }, "pull_requests": { "type": "array", "items": { "type": "object", "required": [ "url", "id", "number", "head", "base" ], "nullable": true, "properties": { "base": { "type": "object", "required": [ "ref", "sha", "repo" ], "properties": { "ref": { "type": "string" }, "repo": { "title": "Repo Ref", "type": "object", "required": [ "id", "url", "name" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } } }, "sha": { "type": "string" } } }, "head": { "type": "object", "required": [ "ref", "sha", "repo" ], "properties": { "ref": { "type": "string" }, "repo": { "title": "Repo Ref", "type": "object", "required": [ "id", "url", "name" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } } }, "sha": { "type": "string" } } }, "id": { "type": "number" }, "number": { "type": "number" }, "url": { "type": "string", "format": "uri" } } } }, "referenced_workflows": { "type": "array", "nullable": true, "items": { "type": "object", "required": [ "path", "sha" ], "properties": { "path": { "type": "string" }, "ref": { "type": "string" }, "sha": { "type": "string" } } } }, "repository": { "title": "Repository Lite", "type": "object", "required": [ "archive_url", "assignees_url", "blobs_url", "branches_url", "collaborators_url", "comments_url", "commits_url", "compare_url", "contents_url", "contributors_url", "deployments_url", "description", "downloads_url", "events_url", "fork", "forks_url", "full_name", "git_commits_url", "git_refs_url", "git_tags_url", "hooks_url", "html_url", "id", "issue_comment_url", "issue_events_url", "issues_url", "keys_url", "labels_url", "languages_url", "merges_url", "milestones_url", "name", "node_id", "notifications_url", "owner", "private", "pulls_url", "releases_url", "stargazers_url", "statuses_url", "subscribers_url", "subscription_url", "tags_url", "teams_url", "trees_url", "url" ], "properties": { "archive_url": { "type": "string", "format": "uri-template" }, "assignees_url": { "type": "string", "format": "uri-template" }, "blobs_url": { "type": "string", "format": "uri-template" }, "branches_url": { "type": "string", "format": "uri-template" }, "collaborators_url": { "type": "string", "format": "uri-template" }, "comments_url": { "type": "string", "format": "uri-template" }, "commits_url": { "type": "string", "format": "uri-template" }, "compare_url": { "type": "string", "format": "uri-template" }, "contents_url": { "type": "string", "format": "uri-template" }, "contributors_url": { "type": "string", "format": "uri" }, "deployments_url": { "type": "string", "format": "uri" }, "description": { "type": "string", "nullable": true }, "downloads_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "fork": { "type": "boolean" }, "forks_url": { "type": "string", "format": "uri" }, "full_name": { "type": "string" }, "git_commits_url": { "type": "string", "format": "uri-template" }, "git_refs_url": { "type": "string", "format": "uri-template" }, "git_tags_url": { "type": "string", "format": "uri-template" }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer" }, "issue_comment_url": { "type": "string", "format": "uri-template" }, "issue_events_url": { "type": "string", "format": "uri-template" }, "issues_url": { "type": "string", "format": "uri-template" }, "keys_url": { "type": "string", "format": "uri-template" }, "labels_url": { "type": "string", "format": "uri-template" }, "languages_url": { "type": "string", "format": "uri" }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "name": { "description": "The name of the repository.", "type": "string" }, "node_id": { "type": "string" }, "notifications_url": { "type": "string", "format": "uri-template" }, "owner": { "title": "User", "type": "object", "nullable": true, "required": [ "login", "id" ], "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" } } }, "private": { "description": "Whether the repository is private or public.", "type": "boolean" }, "pulls_url": { "type": "string", "format": "uri-template" }, "releases_url": { "type": "string", "format": "uri-template" }, "stargazers_url": { "type": "string", "format": "uri" }, "statuses_url": { "type": "string", "format": "uri-template" }, "subscribers_url": { "type": "string", "format": "uri" }, "subscription_url": { "type": "string", "format": "uri" }, "tags_url": { "type": "string", "format": "uri" }, "teams_url": { "type": "string", "format": "uri" }, "trees_url": { "type": "string", "format": "uri-template" }, "url": { "type": "string", "format": "uri" } } }, "rerun_url": { "type": "string", "format": "uri" }, "run_attempt": { "type": "integer" }, "run_number": { "type": "integer" }, "run_started_at": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "requested", "in_progress", "completed", "queued", "pending", "waiting" ] }, "triggering_actor": { "title": "User", "type": "object", "nullable": true, "required": [ "login", "id" ], "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" } } }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "type": "string", "format": "uri" }, "workflow_id": { "type": "integer" }, "workflow_url": { "type": "string", "format": "uri" }, "display_title": { "type": "string", "example": "Simple Workflow", "description": "The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow." } } } }, "required": [ "action", "repository", "sender", "workflow", "workflow_run" ] }