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

Github Event `fork` #

Github Action Trigger #

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`fork`	Not applicable	Last commit on default branch	Default branch

Note: This event will only trigger a workflow run if the workflow file is on the default branch.

Runs your workflow when someone forks a repository. For information about the REST API, see “REST API endpoints for repositories.”

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

on:
  fork

Event Payload #

source

This event occurs when someone forks a repository. For more information, see "Fork a repo." For information about the API to manage forks, see "Forks" in the REST API documentation.

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

field	type	required	description
`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.forkee`	object	required	The created `repository` resource.
`github.event.forkee.allow_auto_merge`	boolean	optional	Whether to allow auto-merge for pull requests.
`github.event.forkee.allow_forking`	boolean	optional
`github.event.forkee.allow_merge_commit`	boolean	optional	Whether to allow merge commits for pull requests.
`github.event.forkee.allow_rebase_merge`	boolean	optional	Whether to allow rebase merges for pull requests.
`github.event.forkee.allow_squash_merge`	boolean	optional	Whether to allow squash merges for pull requests.
`github.event.forkee.allow_update_branch`	boolean	optional
`github.event.forkee.archive_url`	string	required
`github.event.forkee.archived`	boolean	required	Whether the repository is archived.
`github.event.forkee.assignees_url`	string	required
`github.event.forkee.blobs_url`	string	required
`github.event.forkee.branches_url`	string	required
`github.event.forkee.clone_url`	string	required
`github.event.forkee.collaborators_url`	string	required
`github.event.forkee.comments_url`	string	required
`github.event.forkee.commits_url`	string	required
`github.event.forkee.compare_url`	string	required
`github.event.forkee.contents_url`	string	required
`github.event.forkee.contributors_url`	string	required
`github.event.forkee.created_at`	integer or string	required
`github.event.forkee.custom_properties`	object	optional	The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
`github.event.forkee.default_branch`	string	required	The default branch of the repository.
`github.event.forkee.delete_branch_on_merge`	boolean	optional	Whether to delete head branches when pull requests are merged
`github.event.forkee.deployments_url`	string	required
`github.event.forkee.description`	string or null	required
`github.event.forkee.disabled`	boolean	optional
`github.event.forkee.downloads_url`	string	required
`github.event.forkee.events_url`	string	required
`github.event.forkee.fork`	boolean	required
`github.event.forkee.forks`	integer	required
`github.event.forkee.forks_count`	integer	required
`github.event.forkee.forks_url`	string	required
`github.event.forkee.full_name`	string	required
`github.event.forkee.git_commits_url`	string	required
`github.event.forkee.git_refs_url`	string	required
`github.event.forkee.git_tags_url`	string	required
`github.event.forkee.git_url`	string	required
`github.event.forkee.has_downloads`	boolean	required	Whether downloads are enabled.
`github.event.forkee.has_issues`	boolean	required	Whether issues are enabled.
`github.event.forkee.has_pages`	boolean	required
`github.event.forkee.has_projects`	boolean	required	Whether projects are enabled.
`github.event.forkee.has_wiki`	boolean	required	Whether the wiki is enabled.
`github.event.forkee.homepage`	string or null	required
`github.event.forkee.hooks_url`	string	required
`github.event.forkee.html_url`	string	required
`github.event.forkee.id`	integer	required	Unique identifier of the repository
`github.event.forkee.is_template`	boolean	optional
`github.event.forkee.issue_comment_url`	string	required
`github.event.forkee.issue_events_url`	string	required
`github.event.forkee.issues_url`	string	required
`github.event.forkee.keys_url`	string	required
`github.event.forkee.labels_url`	string	required
`github.event.forkee.language`	string or null	required
`github.event.forkee.languages_url`	string	required
`github.event.forkee.license`	object or null	required
`github.event.forkee.license.key`	string	required
`github.event.forkee.license.name`	string	required
`github.event.forkee.license.node_id`	string	required
`github.event.forkee.license.spdx_id`	string	required
`github.event.forkee.license.url`	string or null	required
`github.event.forkee.master_branch`	string	optional
`github.event.forkee.merges_url`	string	required
`github.event.forkee.milestones_url`	string	required
`github.event.forkee.mirror_url`	string or null	required
`github.event.forkee.name`	string	required	The name of the repository.
`github.event.forkee.node_id`	string	required
`github.event.forkee.notifications_url`	string	required
`github.event.forkee.open_issues`	integer	required
`github.event.forkee.open_issues_count`	integer	required
`github.event.forkee.organization`	string	optional
`github.event.forkee.owner`	object or null	required
`github.event.forkee.owner.avatar_url`	string	optional
`github.event.forkee.owner.deleted`	boolean	optional
`github.event.forkee.owner.email`	string or null	optional
`github.event.forkee.owner.events_url`	string	optional
`github.event.forkee.owner.followers_url`	string	optional
`github.event.forkee.owner.following_url`	string	optional
`github.event.forkee.owner.gists_url`	string	optional
`github.event.forkee.owner.gravatar_id`	string	optional
`github.event.forkee.owner.html_url`	string	optional
`github.event.forkee.owner.id`	integer	required
`github.event.forkee.owner.login`	string	required
`github.event.forkee.owner.name`	string	optional
`github.event.forkee.owner.node_id`	string	optional
`github.event.forkee.owner.organizations_url`	string	optional
`github.event.forkee.owner.received_events_url`	string	optional
`github.event.forkee.owner.repos_url`	string	optional
`github.event.forkee.owner.site_admin`	boolean	optional
`github.event.forkee.owner.starred_url`	string	optional
`github.event.forkee.owner.subscriptions_url`	string	optional
`github.event.forkee.owner.type`	`Bot`, `User`, `Organization`	optional
`github.event.forkee.owner.url`	string	optional
`github.event.forkee.permissions`	object	optional
`github.event.forkee.permissions.admin`	boolean	required
`github.event.forkee.permissions.maintain`	boolean	optional
`github.event.forkee.permissions.pull`	boolean	required
`github.event.forkee.permissions.push`	boolean	required
`github.event.forkee.permissions.triage`	boolean	optional
`github.event.forkee.private`	boolean	required	Whether the repository is private or public.
`github.event.forkee.public`	boolean	optional
`github.event.forkee.pulls_url`	string	required
`github.event.forkee.pushed_at`	null or integer or string	required
`github.event.forkee.releases_url`	string	required
`github.event.forkee.role_name`	string or null	optional
`github.event.forkee.size`	integer	required
`github.event.forkee.ssh_url`	string	required
`github.event.forkee.stargazers`	integer	optional
`github.event.forkee.stargazers_count`	integer	required
`github.event.forkee.stargazers_url`	string	required
`github.event.forkee.statuses_url`	string	required
`github.event.forkee.subscribers_url`	string	required
`github.event.forkee.subscription_url`	string	required
`github.event.forkee.svn_url`	string	required
`github.event.forkee.tags_url`	string	required
`github.event.forkee.teams_url`	string	required
`github.event.forkee.topics`	array of strings	required
`github.event.forkee.trees_url`	string	required
`github.event.forkee.updated_at`	string	required
`github.event.forkee.url`	string	required
`github.event.forkee.visibility`	`public`, `private`, `internal`	required
`github.event.forkee.watchers`	integer	required
`github.event.forkee.watchers_count`	integer	required
`github.event.forkee.web_commit_signoff_required`	boolean	optional	Whether to require contributors to sign off on web-based commits
`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 fork #

Github Action Trigger #

Event Payload #

Github Event `fork` #