> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GitHub Webhook Setup Guide

> Configure GitHub to deliver events to StackOne.

## Prerequisites

The connector should already be set up, with a Connector Profile and a Linked Account. See [Getting Started](/connectors/github#getting-started) on the GitHub connector page.

<Panel>
  <div className="not-prose guides-scope-selector" data-guides-scope-selector data-guide-actions-json="[{&#x22;id&#x22;:&#x22;github_list_workflow_runs&#x22;,&#x22;label&#x22;:&#x22;List Workflow Runs&#x22;,&#x22;scopes&#x22;:[&#x22;ActionsRead&#x22;,&#x22;workflow&#x22;]},{&#x22;id&#x22;:&#x22;github_get_workflow_run&#x22;,&#x22;label&#x22;:&#x22;Get Workflow Run&#x22;,&#x22;scopes&#x22;:[&#x22;ActionsRead&#x22;,&#x22;workflow&#x22;]},{&#x22;id&#x22;:&#x22;github_cancel_workflow_run&#x22;,&#x22;label&#x22;:&#x22;Cancel Workflow Run&#x22;,&#x22;scopes&#x22;:[&#x22;ActionsWrite&#x22;,&#x22;workflow&#x22;]},{&#x22;id&#x22;:&#x22;github_re_run_workflow&#x22;,&#x22;label&#x22;:&#x22;Re-run Workflow&#x22;,&#x22;scopes&#x22;:[&#x22;ActionsWrite&#x22;,&#x22;workflow&#x22;]},{&#x22;id&#x22;:&#x22;github_list_workflow_jobs&#x22;,&#x22;label&#x22;:&#x22;List Workflow Jobs&#x22;,&#x22;scopes&#x22;:[&#x22;ActionsRead&#x22;,&#x22;workflow&#x22;]},{&#x22;id&#x22;:&#x22;github_list_artifacts&#x22;,&#x22;label&#x22;:&#x22;List Artifacts&#x22;,&#x22;scopes&#x22;:[&#x22;ActionsRead&#x22;,&#x22;workflow&#x22;]},{&#x22;id&#x22;:&#x22;github_download_artifact&#x22;,&#x22;label&#x22;:&#x22;Download Artifact&#x22;,&#x22;scopes&#x22;:[&#x22;ActionsRead&#x22;,&#x22;workflow&#x22;]},{&#x22;id&#x22;:&#x22;github_create_workflow_dispatch&#x22;,&#x22;label&#x22;:&#x22;Trigger Workflow&#x22;,&#x22;scopes&#x22;:[&#x22;ActionsWrite&#x22;,&#x22;WorkflowsWrite&#x22;,&#x22;repo&#x22;,&#x22;workflow&#x22;]},{&#x22;id&#x22;:&#x22;github_get_branch_protection&#x22;,&#x22;label&#x22;:&#x22;Get Branch Protection&#x22;,&#x22;scopes&#x22;:[&#x22;AdministrationRead&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_get_branch_rules&#x22;,&#x22;label&#x22;:&#x22;Get Branch Rules&#x22;,&#x22;scopes&#x22;:[&#x22;MetadataRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_list_repository_rulesets&#x22;,&#x22;label&#x22;:&#x22;List Repository Rulesets&#x22;,&#x22;scopes&#x22;:[&#x22;MetadataRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_get_repository_ruleset&#x22;,&#x22;label&#x22;:&#x22;Get Repository Ruleset&#x22;,&#x22;scopes&#x22;:[&#x22;MetadataRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_list_organization_rulesets&#x22;,&#x22;label&#x22;:&#x22;List Organization Rulesets&#x22;,&#x22;scopes&#x22;:[&#x22;OrganizationAdministrationWrite&#x22;,&#x22;admin:org&#x22;]},{&#x22;id&#x22;:&#x22;github_get_organization_ruleset&#x22;,&#x22;label&#x22;:&#x22;Get Organization Ruleset&#x22;,&#x22;scopes&#x22;:[&#x22;OrganizationAdministrationWrite&#x22;,&#x22;admin:org&#x22;]},{&#x22;id&#x22;:&#x22;github_list_organization_branch_protection&#x22;,&#x22;label&#x22;:&#x22;List Organization Branch Protection&#x22;,&#x22;scopes&#x22;:[&#x22;AdministrationRead&#x22;,&#x22;MetadataRead&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_list_commits&#x22;,&#x22;label&#x22;:&#x22;List Commits&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_get_commit&#x22;,&#x22;label&#x22;:&#x22;Get Commit&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_list_pull_requests_for_commit&#x22;,&#x22;label&#x22;:&#x22;List Pull Requests For Commit&#x22;,&#x22;scopes&#x22;:[&#x22;PullRequestsRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_list_check_runs_for_ref&#x22;,&#x22;label&#x22;:&#x22;List Check Runs For Ref&#x22;,&#x22;scopes&#x22;:[&#x22;ChecksRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_get_combined_status_for_ref&#x22;,&#x22;label&#x22;:&#x22;Get Combined Status For Ref&#x22;,&#x22;scopes&#x22;:[&#x22;CommitStatusesRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_get_repository_content&#x22;,&#x22;label&#x22;:&#x22;Get Repository Content&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_create_or_update_file&#x22;,&#x22;label&#x22;:&#x22;Create Or Update File&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_delete_file&#x22;,&#x22;label&#x22;:&#x22;Delete File&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_create_deployment&#x22;,&#x22;label&#x22;:&#x22;Create Deployment&#x22;,&#x22;scopes&#x22;:[&#x22;DeploymentsWrite&#x22;,&#x22;repo&#x22;,&#x22;repo_deployment&#x22;]},{&#x22;id&#x22;:&#x22;github_list_deployments&#x22;,&#x22;label&#x22;:&#x22;List Deployments&#x22;,&#x22;scopes&#x22;:[&#x22;DeploymentsRead&#x22;,&#x22;repo&#x22;,&#x22;repo_deployment&#x22;]},{&#x22;id&#x22;:&#x22;github_create_deployment_status&#x22;,&#x22;label&#x22;:&#x22;Create Deployment Status&#x22;,&#x22;scopes&#x22;:[&#x22;DeploymentsWrite&#x22;,&#x22;repo&#x22;,&#x22;repo_deployment&#x22;]},{&#x22;id&#x22;:&#x22;github_delete_deployment&#x22;,&#x22;label&#x22;:&#x22;Delete Deployment&#x22;,&#x22;scopes&#x22;:[&#x22;DeploymentsWrite&#x22;,&#x22;repo&#x22;,&#x22;repo_deployment&#x22;]},{&#x22;id&#x22;:&#x22;github_unified_get_me&#x22;,&#x22;label&#x22;:&#x22;Get Unified Credentials&#x22;,&#x22;scopes&#x22;:[&#x22;EmailAddressesRead&#x22;,&#x22;ProfileRead&#x22;]},{&#x22;id&#x22;:&#x22;github_unified_list_groups&#x22;,&#x22;label&#x22;:&#x22;List Unified Groups&#x22;,&#x22;scopes&#x22;:[&#x22;MembersRead&#x22;,&#x22;read:org&#x22;]},{&#x22;id&#x22;:&#x22;github_unified_get_group&#x22;,&#x22;label&#x22;:&#x22;Get Unified Group&#x22;,&#x22;scopes&#x22;:[&#x22;MembersRead&#x22;,&#x22;read:org&#x22;]},{&#x22;id&#x22;:&#x22;github_unified_list_organizations&#x22;,&#x22;label&#x22;:&#x22;List Unified Organizations&#x22;,&#x22;scopes&#x22;:[&#x22;MembersRead&#x22;,&#x22;read:org&#x22;]},{&#x22;id&#x22;:&#x22;github_unified_get_organization&#x22;,&#x22;label&#x22;:&#x22;Get Unified Organization&#x22;,&#x22;scopes&#x22;:[&#x22;MembersRead&#x22;,&#x22;read:org&#x22;]},{&#x22;id&#x22;:&#x22;github_unified_list_roles&#x22;,&#x22;label&#x22;:&#x22;List Unified Roles&#x22;,&#x22;scopes&#x22;:[&#x22;MetadataRead&#x22;]},{&#x22;id&#x22;:&#x22;github_unified_get_role&#x22;,&#x22;label&#x22;:&#x22;Get Unified Role&#x22;,&#x22;scopes&#x22;:[&#x22;MetadataRead&#x22;]},{&#x22;id&#x22;:&#x22;github_unified_list_users&#x22;,&#x22;label&#x22;:&#x22;List Unified Users&#x22;,&#x22;scopes&#x22;:[&#x22;MembersRead&#x22;,&#x22;read:org&#x22;]},{&#x22;id&#x22;:&#x22;github_unified_get_user&#x22;,&#x22;label&#x22;:&#x22;Get Unified User&#x22;,&#x22;scopes&#x22;:[&#x22;read:user&#x22;]},{&#x22;id&#x22;:&#x22;github_list_issues&#x22;,&#x22;label&#x22;:&#x22;List Issues&#x22;,&#x22;scopes&#x22;:[&#x22;IssuesRead&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_create_issue&#x22;,&#x22;label&#x22;:&#x22;Create Issue&#x22;,&#x22;scopes&#x22;:[&#x22;IssuesWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_get_issue&#x22;,&#x22;label&#x22;:&#x22;Get Issue&#x22;,&#x22;scopes&#x22;:[&#x22;IssuesRead&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_update_issue&#x22;,&#x22;label&#x22;:&#x22;Update Issue&#x22;,&#x22;scopes&#x22;:[&#x22;IssuesWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_create_issue_comment&#x22;,&#x22;label&#x22;:&#x22;Create Issue Comment&#x22;,&#x22;scopes&#x22;:[&#x22;IssuesWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_list_issue_comments&#x22;,&#x22;label&#x22;:&#x22;List Issue Comments&#x22;,&#x22;scopes&#x22;:[&#x22;IssuesRead&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_list_authenticated_user_organizations&#x22;,&#x22;label&#x22;:&#x22;List Authenticated User Organizations&#x22;,&#x22;scopes&#x22;:[&#x22;MembersRead&#x22;,&#x22;admin:org&#x22;,&#x22;read:org&#x22;]},{&#x22;id&#x22;:&#x22;github_list_user_organizations&#x22;,&#x22;label&#x22;:&#x22;List User Organizations&#x22;,&#x22;scopes&#x22;:[&#x22;MembersRead&#x22;,&#x22;admin:org&#x22;,&#x22;read:org&#x22;]},{&#x22;id&#x22;:&#x22;github_get_organization&#x22;,&#x22;label&#x22;:&#x22;Get Organization&#x22;,&#x22;scopes&#x22;:[&#x22;MembersRead&#x22;,&#x22;admin:org&#x22;,&#x22;read:org&#x22;]},{&#x22;id&#x22;:&#x22;github_update_organization&#x22;,&#x22;label&#x22;:&#x22;Update Organization&#x22;,&#x22;scopes&#x22;:[&#x22;OrganizationAdministrationWrite&#x22;,&#x22;admin:org&#x22;]},{&#x22;id&#x22;:&#x22;github_list_organization_members&#x22;,&#x22;label&#x22;:&#x22;List Organization Members&#x22;,&#x22;scopes&#x22;:[&#x22;MembersRead&#x22;,&#x22;admin:org&#x22;,&#x22;read:org&#x22;]},{&#x22;id&#x22;:&#x22;github_list_outside_collaborators&#x22;,&#x22;label&#x22;:&#x22;List Outside Collaborators&#x22;,&#x22;scopes&#x22;:[&#x22;MembersRead&#x22;,&#x22;admin:org&#x22;,&#x22;read:org&#x22;]},{&#x22;id&#x22;:&#x22;github_list_organization_members_with_two_factor&#x22;,&#x22;label&#x22;:&#x22;List Organization Members With Two-Factor Status&#x22;,&#x22;scopes&#x22;:[&#x22;MembersRead&#x22;,&#x22;admin:org&#x22;,&#x22;read:org&#x22;]},{&#x22;id&#x22;:&#x22;github_list_organization_audit_log&#x22;,&#x22;label&#x22;:&#x22;List Organization Audit Log&#x22;,&#x22;scopes&#x22;:[&#x22;OrganizationAdministrationRead&#x22;,&#x22;admin:org&#x22;,&#x22;read:org&#x22;,&#x22;read:audit_log&#x22;]},{&#x22;id&#x22;:&#x22;github_list_enterprise_audit_log&#x22;,&#x22;label&#x22;:&#x22;List Enterprise Audit Log&#x22;,&#x22;scopes&#x22;:[&#x22;admin:enterprise&#x22;,&#x22;read:audit_log&#x22;]},{&#x22;id&#x22;:&#x22;github_check_organization_membership&#x22;,&#x22;label&#x22;:&#x22;Check Organization Membership&#x22;,&#x22;scopes&#x22;:[&#x22;MembersRead&#x22;,&#x22;admin:org&#x22;,&#x22;read:org&#x22;]},{&#x22;id&#x22;:&#x22;github_get_organization_membership&#x22;,&#x22;label&#x22;:&#x22;Get Organization Membership&#x22;,&#x22;scopes&#x22;:[&#x22;MembersRead&#x22;,&#x22;admin:org&#x22;,&#x22;read:org&#x22;]},{&#x22;id&#x22;:&#x22;github_list_authenticated_user_organization_memberships&#x22;,&#x22;label&#x22;:&#x22;List Authenticated User Organization Memberships&#x22;,&#x22;scopes&#x22;:[&#x22;read:org&#x22;]},{&#x22;id&#x22;:&#x22;github_invite_organization_member&#x22;,&#x22;label&#x22;:&#x22;Invite Organization Member&#x22;,&#x22;scopes&#x22;:[&#x22;MembersWrite&#x22;,&#x22;admin:org&#x22;]},{&#x22;id&#x22;:&#x22;github_remove_organization_member&#x22;,&#x22;label&#x22;:&#x22;Remove Organization Member&#x22;,&#x22;scopes&#x22;:[&#x22;MembersWrite&#x22;,&#x22;admin:org&#x22;]},{&#x22;id&#x22;:&#x22;github_list_pull_requests&#x22;,&#x22;label&#x22;:&#x22;List Pull Requests&#x22;,&#x22;scopes&#x22;:[&#x22;PullRequestsRead&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_create_pull_request&#x22;,&#x22;label&#x22;:&#x22;Create Pull Request&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;PullRequestsWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_get_pull_request&#x22;,&#x22;label&#x22;:&#x22;Get Pull Request&#x22;,&#x22;scopes&#x22;:[&#x22;PullRequestsRead&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_update_pull_request&#x22;,&#x22;label&#x22;:&#x22;Update Pull Request&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;PullRequestsWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_merge_pull_request&#x22;,&#x22;label&#x22;:&#x22;Merge Pull Request&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;PullRequestsWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_list_pull_request_reviews&#x22;,&#x22;label&#x22;:&#x22;List Pull Request Reviews&#x22;,&#x22;scopes&#x22;:[&#x22;PullRequestsRead&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_create_pull_request_review&#x22;,&#x22;label&#x22;:&#x22;Create Pull Request Review&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;PullRequestsWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_create_pull_request_review_comment&#x22;,&#x22;label&#x22;:&#x22;Create Pull Request Review Comment&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;PullRequestsWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_list_matching_refs&#x22;,&#x22;label&#x22;:&#x22;List Matching Git References&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_get_ref&#x22;,&#x22;label&#x22;:&#x22;Get Git Reference&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_create_ref&#x22;,&#x22;label&#x22;:&#x22;Create Git Reference&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_update_ref&#x22;,&#x22;label&#x22;:&#x22;Update Git Reference&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_delete_ref&#x22;,&#x22;label&#x22;:&#x22;Delete Git Reference&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_create_release&#x22;,&#x22;label&#x22;:&#x22;Create Release&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_list_releases&#x22;,&#x22;label&#x22;:&#x22;List Releases&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_get_latest_release&#x22;,&#x22;label&#x22;:&#x22;Get Latest Release&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_update_release&#x22;,&#x22;label&#x22;:&#x22;Update Release&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_upload_release_asset&#x22;,&#x22;label&#x22;:&#x22;Upload Release Asset&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_delete_release&#x22;,&#x22;label&#x22;:&#x22;Delete Release&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_list_authenticated_user_repositories&#x22;,&#x22;label&#x22;:&#x22;List Authenticated User Repositories&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;MetadataRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_list_user_repositories&#x22;,&#x22;label&#x22;:&#x22;List User Repositories&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;MetadataRead&#x22;,&#x22;public_repo&#x22;]},{&#x22;id&#x22;:&#x22;github_list_organization_repositories&#x22;,&#x22;label&#x22;:&#x22;List Organization Repositories&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;MetadataRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_get_repository&#x22;,&#x22;label&#x22;:&#x22;Get Repository&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;MetadataRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_create_user_repository&#x22;,&#x22;label&#x22;:&#x22;Create User Repository&#x22;,&#x22;scopes&#x22;:[&#x22;AdministrationWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_create_organization_repository&#x22;,&#x22;label&#x22;:&#x22;Create Organization Repository&#x22;,&#x22;scopes&#x22;:[&#x22;AdministrationWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_update_repository&#x22;,&#x22;label&#x22;:&#x22;Update Repository&#x22;,&#x22;scopes&#x22;:[&#x22;AdministrationWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_delete_repository&#x22;,&#x22;label&#x22;:&#x22;Delete Repository&#x22;,&#x22;scopes&#x22;:[&#x22;AdministrationWrite&#x22;,&#x22;delete_repo&#x22;]},{&#x22;id&#x22;:&#x22;github_fork_repository&#x22;,&#x22;label&#x22;:&#x22;Fork Repository&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_list_forks&#x22;,&#x22;label&#x22;:&#x22;List Forks&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;MetadataRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_list_branches&#x22;,&#x22;label&#x22;:&#x22;List Branches&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;MetadataRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_get_branch&#x22;,&#x22;label&#x22;:&#x22;Get Branch&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;MetadataRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_star_repository&#x22;,&#x22;label&#x22;:&#x22;Star Repository&#x22;,&#x22;scopes&#x22;:[&#x22;StarringWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_unstar_repository&#x22;,&#x22;label&#x22;:&#x22;Unstar Repository&#x22;,&#x22;scopes&#x22;:[&#x22;StarringWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_search_code&#x22;,&#x22;label&#x22;:&#x22;Search Code&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;MetadataRead&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_search_repositories&#x22;,&#x22;label&#x22;:&#x22;Search Repositories&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;MetadataRead&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_search_issues&#x22;,&#x22;label&#x22;:&#x22;Search Issues&#x22;,&#x22;scopes&#x22;:[&#x22;ContentsRead&#x22;,&#x22;MetadataRead&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_search_pull_requests_with_reviews&#x22;,&#x22;label&#x22;:&#x22;Search Pull Requests With Reviews&#x22;,&#x22;scopes&#x22;:[&#x22;PullRequestsRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_list_code_scanning_alerts&#x22;,&#x22;label&#x22;:&#x22;List Code Scanning Alerts&#x22;,&#x22;scopes&#x22;:[&#x22;SecurityEventsRead&#x22;,&#x22;repo&#x22;,&#x22;security_events&#x22;]},{&#x22;id&#x22;:&#x22;github_list_secret_scanning_alerts&#x22;,&#x22;label&#x22;:&#x22;List Secret Scanning Alerts&#x22;,&#x22;scopes&#x22;:[&#x22;SecurityEventsRead&#x22;,&#x22;repo&#x22;,&#x22;security_events&#x22;]},{&#x22;id&#x22;:&#x22;github_list_dependabot_alerts&#x22;,&#x22;label&#x22;:&#x22;List Dependabot Alerts&#x22;,&#x22;scopes&#x22;:[&#x22;SecurityEventsRead&#x22;,&#x22;repo&#x22;,&#x22;security_events&#x22;]},{&#x22;id&#x22;:&#x22;github_update_code_scanning_alert&#x22;,&#x22;label&#x22;:&#x22;Update Code Scanning Alert&#x22;,&#x22;scopes&#x22;:[&#x22;CodeScanningAlertsWrite&#x22;,&#x22;repo&#x22;,&#x22;security_events&#x22;]},{&#x22;id&#x22;:&#x22;github_update_secret_scanning_alert&#x22;,&#x22;label&#x22;:&#x22;Update Secret Scanning Alert&#x22;,&#x22;scopes&#x22;:[&#x22;SecretScanningAlertsWrite&#x22;,&#x22;repo&#x22;,&#x22;security_events&#x22;]},{&#x22;id&#x22;:&#x22;github_update_dependabot_alert&#x22;,&#x22;label&#x22;:&#x22;Update Dependabot Alert&#x22;,&#x22;scopes&#x22;:[&#x22;DependabotAlertsWrite&#x22;,&#x22;repo&#x22;,&#x22;security_events&#x22;]},{&#x22;id&#x22;:&#x22;github_create_team&#x22;,&#x22;label&#x22;:&#x22;Create Team&#x22;,&#x22;scopes&#x22;:[&#x22;MembersWrite&#x22;,&#x22;admin:org&#x22;]},{&#x22;id&#x22;:&#x22;github_list_teams&#x22;,&#x22;label&#x22;:&#x22;List Teams&#x22;,&#x22;scopes&#x22;:[&#x22;MembersRead&#x22;,&#x22;admin:org&#x22;,&#x22;read:org&#x22;]},{&#x22;id&#x22;:&#x22;github_get_team&#x22;,&#x22;label&#x22;:&#x22;Get Team&#x22;,&#x22;scopes&#x22;:[&#x22;MembersRead&#x22;,&#x22;admin:org&#x22;,&#x22;read:org&#x22;]},{&#x22;id&#x22;:&#x22;github_list_team_members&#x22;,&#x22;label&#x22;:&#x22;List Team Members&#x22;,&#x22;scopes&#x22;:[&#x22;MembersRead&#x22;,&#x22;admin:org&#x22;,&#x22;read:org&#x22;]},{&#x22;id&#x22;:&#x22;github_list_team_repositories&#x22;,&#x22;label&#x22;:&#x22;List Team Repositories&#x22;,&#x22;scopes&#x22;:[&#x22;MembersRead&#x22;,&#x22;read:org&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_list_repository_teams&#x22;,&#x22;label&#x22;:&#x22;List Repository Teams&#x22;,&#x22;scopes&#x22;:[&#x22;AdministrationRead&#x22;,&#x22;public_repo&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_update_team&#x22;,&#x22;label&#x22;:&#x22;Update Team&#x22;,&#x22;scopes&#x22;:[&#x22;MembersWrite&#x22;,&#x22;admin:org&#x22;]},{&#x22;id&#x22;:&#x22;github_delete_team&#x22;,&#x22;label&#x22;:&#x22;Delete Team&#x22;,&#x22;scopes&#x22;:[&#x22;MembersWrite&#x22;,&#x22;admin:org&#x22;]},{&#x22;id&#x22;:&#x22;github_add_team_member&#x22;,&#x22;label&#x22;:&#x22;Add Team Member&#x22;,&#x22;scopes&#x22;:[&#x22;MembersWrite&#x22;,&#x22;admin:org&#x22;]},{&#x22;id&#x22;:&#x22;github_remove_team_member&#x22;,&#x22;label&#x22;:&#x22;Remove Team Member&#x22;,&#x22;scopes&#x22;:[&#x22;MembersWrite&#x22;,&#x22;admin:org&#x22;]},{&#x22;id&#x22;:&#x22;github_add_team_repository&#x22;,&#x22;label&#x22;:&#x22;Add Team Repository&#x22;,&#x22;scopes&#x22;:[&#x22;MembersWrite&#x22;,&#x22;admin:org&#x22;]},{&#x22;id&#x22;:&#x22;github_list_users&#x22;,&#x22;label&#x22;:&#x22;List Users&#x22;,&#x22;scopes&#x22;:[&#x22;MetadataRead&#x22;,&#x22;read:user&#x22;]},{&#x22;id&#x22;:&#x22;github_get_user&#x22;,&#x22;label&#x22;:&#x22;Get User&#x22;,&#x22;scopes&#x22;:[&#x22;MetadataRead&#x22;,&#x22;read:user&#x22;]},{&#x22;id&#x22;:&#x22;github_get_authenticated_user&#x22;,&#x22;label&#x22;:&#x22;Get Authenticated User&#x22;,&#x22;scopes&#x22;:[&#x22;EmailAddressesRead&#x22;,&#x22;ProfileRead&#x22;,&#x22;read:user&#x22;,&#x22;user&#x22;]},{&#x22;id&#x22;:&#x22;github_update_user&#x22;,&#x22;label&#x22;:&#x22;Update User&#x22;,&#x22;scopes&#x22;:[&#x22;ProfileWrite&#x22;,&#x22;user&#x22;]},{&#x22;id&#x22;:&#x22;github_list_collaborators&#x22;,&#x22;label&#x22;:&#x22;List Collaborators&#x22;,&#x22;scopes&#x22;:[&#x22;MetadataRead&#x22;,&#x22;read:org&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_add_collaborator&#x22;,&#x22;label&#x22;:&#x22;Add Collaborator&#x22;,&#x22;scopes&#x22;:[&#x22;AdministrationWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_remove_collaborator&#x22;,&#x22;label&#x22;:&#x22;Remove Collaborator&#x22;,&#x22;scopes&#x22;:[&#x22;AdministrationWrite&#x22;,&#x22;repo&#x22;]},{&#x22;id&#x22;:&#x22;github_create_webhook&#x22;,&#x22;label&#x22;:&#x22;Create Webhook&#x22;,&#x22;scopes&#x22;:[&#x22;WebhooksWrite&#x22;,&#x22;write:repo_hook&#x22;]},{&#x22;id&#x22;:&#x22;github_list_webhooks&#x22;,&#x22;label&#x22;:&#x22;List Webhooks&#x22;,&#x22;scopes&#x22;:[&#x22;WebhooksRead&#x22;,&#x22;read:repo_hook&#x22;]},{&#x22;id&#x22;:&#x22;github_ping_webhook&#x22;,&#x22;label&#x22;:&#x22;Ping Webhook&#x22;,&#x22;scopes&#x22;:[&#x22;WebhooksWrite&#x22;,&#x22;write:repo_hook&#x22;]},{&#x22;id&#x22;:&#x22;github_get_webhook&#x22;,&#x22;label&#x22;:&#x22;Get Webhook&#x22;,&#x22;scopes&#x22;:[&#x22;WebhooksRead&#x22;,&#x22;read:repo_hook&#x22;]},{&#x22;id&#x22;:&#x22;github_update_webhook&#x22;,&#x22;label&#x22;:&#x22;Update Webhook&#x22;,&#x22;scopes&#x22;:[&#x22;WebhooksWrite&#x22;,&#x22;write:repo_hook&#x22;]},{&#x22;id&#x22;:&#x22;github_delete_webhook&#x22;,&#x22;label&#x22;:&#x22;Delete Webhook&#x22;,&#x22;scopes&#x22;:[&#x22;WebhooksWrite&#x22;,&#x22;write:repo_hook&#x22;]}]">
    <div className="guides-scope-selector__title">Select Actions to adjust the guide</div>
    <div className="guides-scope-selector__muted guides-scope-selector__subtitle">Some actions may require additional configuration in the provider to be accessible. Choose the actions you need and the guide will be updated.</div>

    <div className="guides-scope-selector__toolbar">
      <input type="text" placeholder="Search actions..." className="guides-scope-selector__input guides-scope-selector__search" data-guide-action-search />

      <button type="button" className="guides-scope-selector__quick-btn" data-guide-select-all>Select all</button>
      <button type="button" className="guides-scope-selector__quick-btn" data-guide-clear>Clear</button>
    </div>

    <div className="guides-scope-selector__list">
      <div className="guides-scope-selector__list-header">
        <div className="guides-scope-selector__list-header-spacer" />

        <div className="guides-scope-selector__list-header-action">Action</div>
        <div className="guides-scope-selector__list-header-scopes">Scope(s)</div>
      </div>

      <div className="guides-scope-selector__muted guides-scope-selector__status" data-guide-loading>Loading actions...</div>
      <div className="guides-scope-selector__muted guides-scope-selector__status" data-guide-no-results hidden>No actions match your search.</div>
    </div>

    <div className="guides-scope-selector__url-section">
      <div className="guides-scope-selector__muted guides-scope-selector__label">Dynamic Guide URL</div>

      <div className="guides-scope-selector__url-row">
        <input type="text" readOnly className="guides-scope-selector__input guides-scope-selector__url-input" data-guide-url />

        <button type="button" className="guides-scope-selector__copy-btn guides-scope-selector__copy-btn--end" data-guide-copy-url>Copy URL</button>
      </div>

      <div className="guides-scope-selector__scopes-section">
        <div className="guides-scope-selector__muted guides-scope-selector__label">Scopes Selected</div>

        <div className="guides-scope-selector__scopes-row">
          <pre className="guides-scope-selector__input guides-scope-selector__scopes-output" role="textbox" aria-readonly="true" tabIndex={0} data-guide-scopes-output />

          <div className="guides-scope-selector__muted guides-scope-selector__side-controls">
            <div className="guides-scope-selector__side-label">Separator</div>

            <select className="guides-scope-selector__input guides-scope-selector__delimiter" data-guide-scope-delimiter>
              <option value="space">Space</option>
              <option value="comma">Comma</option>
              <option value="semicolon">Semicolon</option>
              <option value="pipe">Pipe</option>
              <option value="newline">Newline</option>
            </select>

            <button type="button" className="guides-scope-selector__copy-btn" data-guide-copy-scopes>Copy scopes</button>
          </div>
        </div>
      </div>
    </div>
  </div>
</Panel>

<section data-guide-section data-guide-scopes="">
  <h2>Setting Up Webhooks with a GitHub App</h2>

  <p>Follow these steps if you connected your account with a GitHub App and wish to receive real-time event notifications. Webhooks are registered per repository or per organisation, and each linked StackOne account has its own Native Webhook URL.<br /><br />If you connected with a Personal Access Token instead, follow the next section.</p>

  <Steps>
    <Step title="Access Developer Settings">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Sign in to your <a href="https://github.com/login" target="_blank" rel="noopener noreferrer">GitHub account</a>, or to your own instance on GitHub Enterprise Server, and navigate to developer settings.</p>

        <ul>
          <li>Click your profile photo in the upper-right corner</li>
          <li>Select <strong>Settings</strong> from the dropdown</li>
          <li>In the left sidebar, scroll down and click <strong>Developer settings</strong></li>
          <li>Create a GitHub App if you have not already done so (see the previous section), or open your existing app by clicking its name under <strong>GitHub Apps</strong> in the left sidebar</li>
        </ul>
      </div>
    </Step>

    <Step title="Copy the Native Webhook URL">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>After linking your account in StackOne, a <strong>Native Webhook URL</strong> is generated for that linked account.</p>

        <ul>
          <li>Open <strong>Linked Accounts</strong> in StackOne and click <strong>Edit</strong> on your GitHub account</li>
          <li>Copy the <strong>Native Webhook URL</strong> from the Configuration form</li>
          <li>Note: The URL is unique to this linked account. Do not reuse it for another account.</li>
        </ul>
      </div>
    </Step>

    <Step title="Add the Webhook URL to Your Repository or Organisation">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Add the URL you copied to each GitHub repository or organisation you wish to receive events from.</p>

        <ul>
          <li>Scroll to the <strong>Webhooks</strong> section of your GitHub repository or organisation settings</li>
          <li>Paste the copied <strong>Native Webhook URL</strong> into the <strong>Webhook URL</strong> field</li>
          <li>Leave the <strong>Secret</strong> field empty</li>
          <li>Keep <strong>Enable SSL verification</strong> selected</li>
          <li>Select <strong>Active</strong> to enable the webhook</li>
          <li>Click <strong>Save Changes</strong> to save the webhook</li>
        </ul>

        <img src="https://mintcdn.com/stackone-60/T7KTxzGb98DXtxyr/connectors/github/images/github-app-developer-settings-webhook-form.png?fit=max&auto=format&n=T7KTxzGb98DXtxyr&q=85&s=dee0427daddca050ec3ba59f0663eb45" alt="GitHub App developer settings webhook form" width="1101" height="559" data-path="connectors/github/images/github-app-developer-settings-webhook-form.png" />
      </div>
    </Step>

    <Step title="Configure the Permissions & Events Tab">
      <div data-guide-step data-guide-scopes="ActionsRead,ActionsWrite,AdministrationWrite,ContentsRead,ContentsWrite,DeploymentsRead,DeploymentsWrite,EmailAddressesRead,IssuesRead,IssuesWrite,MembersRead,MembersWrite,MetadataRead,ProfileRead,ProfileWrite,PullRequestsRead,PullRequestsWrite,SecurityEventsRead,WebhooksRead,WebhooksWrite,ChecksRead,ChecksWrite,CommitStatusesRead,CodeScanningAlertsRead,CodeScanningAlertsWrite,DependabotAlertsRead,DependabotAlertsWrite,SecretScanningAlertsRead,SecretScanningAlertsWrite,StarringRead,StarringWrite" data-guide-display-scopes-list="ActionsRead,ActionsWrite,AdministrationWrite,ContentsRead,ContentsWrite,DeploymentsRead,DeploymentsWrite,EmailAddressesRead,IssuesRead,IssuesWrite,MembersRead,MembersWrite,MetadataRead,ProfileRead,ProfileWrite,PullRequestsRead,PullRequestsWrite,SecurityEventsRead,WebhooksRead,WebhooksWrite,ChecksRead,ChecksWrite,CommitStatusesRead,CodeScanningAlertsRead,CodeScanningAlertsWrite,DependabotAlertsRead,DependabotAlertsWrite,SecretScanningAlertsRead,SecretScanningAlertsWrite,StarringRead,StarringWrite">
        <div className="connector-guide-actions-badge" data-guide-actions-badge data-guide-actions-badge-scopes="ActionsRead,ActionsWrite,AdministrationWrite,ContentsRead,ContentsWrite,DeploymentsRead,DeploymentsWrite,EmailAddressesRead,IssuesRead,IssuesWrite,MembersRead,MembersWrite,MetadataRead,ProfileRead,ProfileWrite,PullRequestsRead,PullRequestsWrite,SecurityEventsRead,WebhooksRead,WebhooksWrite,ChecksRead,ChecksWrite,CommitStatusesRead,CodeScanningAlertsRead,CodeScanningAlertsWrite,DependabotAlertsRead,DependabotAlertsWrite,SecretScanningAlertsRead,SecretScanningAlertsWrite,StarringRead,StarringWrite">
          <span>Enables actions: </span><span data-guide-actions-badge-labels>Add Collaborator, Add Team Member, Add Team Repository, Cancel Workflow Run, Check Organization Membership, Create Deployment, Create Deployment Status, Create Git Reference, Create Issue, Create Issue Comment, Create Or Update File, Create Organization Repository, Create Pull Request, Create Pull Request Review, Create Pull Request Review Comment, Create Release, Create Team, Create User Repository, Create Webhook, Delete Deployment, Delete File, Delete Git Reference, Delete Release, Delete Repository, Delete Team, Delete Webhook, Download Artifact, Fork Repository, Get Authenticated User, Get Branch, Get Branch Rules, Get Combined Status For Ref, Get Commit, Get Git Reference, Get Issue, Get Latest Release, Get Organization, Get Organization Membership, Get Pull Request, Get Repository, Get Repository Content, Get Repository Ruleset, Get Team, Get Unified Credentials, Get Unified Group, Get Unified Organization, Get Unified Role, Get User, Get Webhook, Get Workflow Run, Invite Organization Member, List Artifacts, List Authenticated User Organizations, List Authenticated User Repositories, List Branches, List Check Runs For Ref, List Code Scanning Alerts, List Collaborators, List Commits, List Dependabot Alerts, List Deployments, List Forks, List Issue Comments, List Issues, List Matching Git References, List Organization Branch Protection, List Organization Members, List Organization Members With Two-Factor Status, List Organization Repositories, List Outside Collaborators, List Pull Request Reviews, List Pull Requests, List Pull Requests For Commit, List Releases, List Repository Rulesets, List Secret Scanning Alerts, List Team Members, List Team Repositories, List Teams, List Unified Groups, List Unified Organizations, List Unified Roles, List Unified Users, List User Organizations, List User Repositories, List Users, List Webhooks, List Workflow Jobs, List Workflow Runs, Merge Pull Request, Ping Webhook, Re-run Workflow, Remove Collaborator, Remove Organization Member, Remove Team Member, Search Code, Search Issues, Search Pull Requests With Reviews, Search Repositories, Star Repository, Trigger Workflow, Unstar Repository, Update Code Scanning Alert, Update Dependabot Alert, Update Git Reference, Update Issue, Update Pull Request, Update Release, Update Repository, Update Secret Scanning Alert, Update Team, Update User, Update Webhook, Upload Release Asset</span>
        </div>

        <p>Set the permissions your integration requires. GitHub Apps use fine-grained permissions rather than traditional OAuth scopes.<br /><br />Important: these permissions are set in the GitHub App configuration and cannot be changed during authorisation. Users see these permissions when they authorise the app, and can choose which repositories to grant access to.</p>

        <ul>
          <li>Select <strong>Permissions & events</strong> in the left sidebar</li>
          <li>Under <strong>Subscribe to events</strong>, select the events you wish to receive:</li>
          <li>- <strong>Code scanning alert</strong>: Code Scanning alert updated. This event is triggered when the assignees or state of the alert changes. The state can be created, fixed in branch, or closed.</li>
          <li>- <strong>Check run</strong>: Check run is created, requested, rerequested, or completed.</li>
          <li>- <strong>Check suite</strong>: Check suite is requested, rerequested, or completed.</li>
          <li>- <strong>Create</strong>: Branch or tag created.</li>
          <li>- <strong>Delete</strong>: Branch or tag deleted.</li>
          <li>- <strong>Dependabot alert</strong>: Dependabot alert assignees\_changed, auto\_dismissed, auto\_reopened, created, dismissed, reopened, fixed, or reintroduced.</li>
          <li>- <strong>Deployment</strong>: Repository was deployed or a deployment was deleted.</li>
          <li>- <strong>Deployment status</strong>: Deployment status updated from the API.</li>
          <li>- <strong>Fork</strong>: Repository forked.</li>
          <li>- <strong>Issues</strong>: Issue opened, edited, deleted, transferred, pinned, unpinned, closed, reopened, assigned, unassigned, labeled, unlabeled, milestoned, demilestoned, locked, unlocked, typed, untyped, field\_added, or field\_removed.</li>
          <li>- <strong>Issue comment</strong>: Issue comment created, edited, or deleted.</li>
          <li>- <strong>Member</strong>: Collaborator added to, removed from, or has changed permissions for a repository.</li>
          <li>- <strong>Organization</strong>: Organization deleted, renamed, member invited, member added, or member removed.</li>
          <li>- <strong>Pull request</strong>: Pull request assigned, auto merge disabled, auto merge enabled, closed, converted to draft, demilestoned, dequeued, edited, enqueued, labeled, locked, milestoned, opened, ready for review, reopened, review request removed, review requested, synchronized, unassigned, unlabeled, or unlocked.</li>
          <li>- <strong>Pull request review</strong>: Pull request review submitted, edited, or dismissed.</li>
          <li>- <strong>Pull request review comment</strong>: Pull request diff comment created, edited, or deleted.</li>
          <li>- <strong>Push</strong>: Git push to a repository.</li>
          <li>- <strong>Release</strong>: Release created, edited, published, unpublished, or deleted.</li>
          <li>- <strong>Repository</strong>: Repository created, deleted, archived, unarchived, publicized, privatized, edited, renamed, or transferred.</li>
          <li>- <strong>Secret scanning alert</strong>: Secret scanning alert created, resolved, reopened, validated, publicly leaked, assigned, or unassigned.</li>
          <li>- <strong>Star</strong>: A star is created or deleted from a repository.</li>
          <li>- <strong>Team</strong>: Team is created, deleted, edited, or added to/removed from a repository.</li>
          <li>- <strong>Workflow job</strong>: Workflow job queued, waiting, in progress, or completed on a repository.</li>
          <li>- <strong>Workflow run</strong>: Workflow run requested or completed on a repository.</li>
          <li>Click <strong>Save changes</strong> at the bottom of the page</li>
        </ul>

        <img src="https://mintcdn.com/stackone-60/T7KTxzGb98DXtxyr/connectors/github/images/github-app-event-subscriptions.png?fit=max&auto=format&n=T7KTxzGb98DXtxyr&q=85&s=bd633d4e747ab5a99b6830cefd93728d" alt="GitHub App event subscriptions" width="1143" height="1346" data-path="connectors/github/images/github-app-event-subscriptions.png" />

        <div className="connector-guide-display-scopes" data-guide-display-scopes>
          <div className="connector-guide-scopes-container connector-guide-scopes-container--scrollable">
            <ul className="not-prose connector-guide-scopes-list">
              <li data-guide-display-scope="ActionsRead">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy ActionsRead" title="Copy scope" data-copy="ActionsRead">
                  <span className="connector-guide-scope-copy__label">ActionsRead</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="ActionsWrite">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy ActionsWrite" title="Copy scope" data-copy="ActionsWrite">
                  <span className="connector-guide-scope-copy__label">ActionsWrite</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="AdministrationWrite">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy AdministrationWrite" title="Copy scope" data-copy="AdministrationWrite">
                  <span className="connector-guide-scope-copy__label">AdministrationWrite</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="ContentsRead">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy ContentsRead" title="Copy scope" data-copy="ContentsRead">
                  <span className="connector-guide-scope-copy__label">ContentsRead</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="ContentsWrite">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy ContentsWrite" title="Copy scope" data-copy="ContentsWrite">
                  <span className="connector-guide-scope-copy__label">ContentsWrite</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="DeploymentsRead">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy DeploymentsRead" title="Copy scope" data-copy="DeploymentsRead">
                  <span className="connector-guide-scope-copy__label">DeploymentsRead</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="DeploymentsWrite">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy DeploymentsWrite" title="Copy scope" data-copy="DeploymentsWrite">
                  <span className="connector-guide-scope-copy__label">DeploymentsWrite</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="EmailAddressesRead">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy EmailAddressesRead" title="Copy scope" data-copy="EmailAddressesRead">
                  <span className="connector-guide-scope-copy__label">EmailAddressesRead</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="IssuesRead">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy IssuesRead" title="Copy scope" data-copy="IssuesRead">
                  <span className="connector-guide-scope-copy__label">IssuesRead</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="IssuesWrite">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy IssuesWrite" title="Copy scope" data-copy="IssuesWrite">
                  <span className="connector-guide-scope-copy__label">IssuesWrite</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="MembersRead">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy MembersRead" title="Copy scope" data-copy="MembersRead">
                  <span className="connector-guide-scope-copy__label">MembersRead</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="MembersWrite">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy MembersWrite" title="Copy scope" data-copy="MembersWrite">
                  <span className="connector-guide-scope-copy__label">MembersWrite</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="MetadataRead">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy MetadataRead" title="Copy scope" data-copy="MetadataRead">
                  <span className="connector-guide-scope-copy__label">MetadataRead</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="ProfileRead">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy ProfileRead" title="Copy scope" data-copy="ProfileRead">
                  <span className="connector-guide-scope-copy__label">ProfileRead</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="ProfileWrite">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy ProfileWrite" title="Copy scope" data-copy="ProfileWrite">
                  <span className="connector-guide-scope-copy__label">ProfileWrite</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="PullRequestsRead">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy PullRequestsRead" title="Copy scope" data-copy="PullRequestsRead">
                  <span className="connector-guide-scope-copy__label">PullRequestsRead</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="PullRequestsWrite">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy PullRequestsWrite" title="Copy scope" data-copy="PullRequestsWrite">
                  <span className="connector-guide-scope-copy__label">PullRequestsWrite</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="SecurityEventsRead">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy SecurityEventsRead" title="Copy scope" data-copy="SecurityEventsRead">
                  <span className="connector-guide-scope-copy__label">SecurityEventsRead</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="WebhooksRead">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy WebhooksRead" title="Copy scope" data-copy="WebhooksRead">
                  <span className="connector-guide-scope-copy__label">WebhooksRead</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="WebhooksWrite">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy WebhooksWrite" title="Copy scope" data-copy="WebhooksWrite">
                  <span className="connector-guide-scope-copy__label">WebhooksWrite</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="ChecksRead">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy ChecksRead" title="Copy scope" data-copy="ChecksRead">
                  <span className="connector-guide-scope-copy__label">ChecksRead</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="ChecksWrite">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy ChecksWrite" title="Copy scope" data-copy="ChecksWrite">
                  <span className="connector-guide-scope-copy__label">ChecksWrite</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="CommitStatusesRead">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy CommitStatusesRead" title="Copy scope" data-copy="CommitStatusesRead">
                  <span className="connector-guide-scope-copy__label">CommitStatusesRead</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="CodeScanningAlertsRead">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy CodeScanningAlertsRead" title="Copy scope" data-copy="CodeScanningAlertsRead">
                  <span className="connector-guide-scope-copy__label">CodeScanningAlertsRead</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="CodeScanningAlertsWrite">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy CodeScanningAlertsWrite" title="Copy scope" data-copy="CodeScanningAlertsWrite">
                  <span className="connector-guide-scope-copy__label">CodeScanningAlertsWrite</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="DependabotAlertsRead">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy DependabotAlertsRead" title="Copy scope" data-copy="DependabotAlertsRead">
                  <span className="connector-guide-scope-copy__label">DependabotAlertsRead</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="DependabotAlertsWrite">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy DependabotAlertsWrite" title="Copy scope" data-copy="DependabotAlertsWrite">
                  <span className="connector-guide-scope-copy__label">DependabotAlertsWrite</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="SecretScanningAlertsRead">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy SecretScanningAlertsRead" title="Copy scope" data-copy="SecretScanningAlertsRead">
                  <span className="connector-guide-scope-copy__label">SecretScanningAlertsRead</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="SecretScanningAlertsWrite">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy SecretScanningAlertsWrite" title="Copy scope" data-copy="SecretScanningAlertsWrite">
                  <span className="connector-guide-scope-copy__label">SecretScanningAlertsWrite</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="StarringRead">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy StarringRead" title="Copy scope" data-copy="StarringRead">
                  <span className="connector-guide-scope-copy__label">StarringRead</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>

              <li data-guide-display-scope="StarringWrite">
                <button type="button" className="connector-guide-scope-copy" aria-label="Copy StarringWrite" title="Copy scope" data-copy="StarringWrite">
                  <span className="connector-guide-scope-copy__label">StarringWrite</span>
                  <span className="connector-guide-scope-copy__icon" aria-hidden="true">⧉</span>
                </button>
              </li>
            </ul>
          </div>
        </div>
      </div>
    </Step>

    <Step title="Reinstall the GitHub App and Reauthorise the Account">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>After updating permissions or events, reinstall the app to apply the new configuration. Existing installations do not pick up changes to permissions or subscribed events automatically.</p>

        <ul>
          <li>Select the <strong>Install App</strong> tab in the left sidebar</li>
          <li>Click the <strong>Configure</strong> icon next to your existing installation</li>
          <li>You are taken to the installation page for the account or organisation where the app is installed</li>
          <li>Click <strong>Authorize</strong> to apply the new permissions and event settings, or accept the updated permissions if you are prompted to review them</li>
          <li>If you are not prompted, uninstall the app and install it again</li>
          <li>After reinstalling, return to StackOne and click <strong>Edit</strong> on the linked account to reauthorise the connection</li>
        </ul>
      </div>
    </Step>
  </Steps>
</section>

<section data-guide-section data-guide-scopes="">
  <h2>Setting Up Webhooks with a Personal Access Token</h2>

  <p>Follow these steps if you connected your account with a Personal Access Token. The webhook is registered directly on the repository or organisation, and each linked StackOne account has its own Native Webhook URL.</p>

  <Steps>
    <Step title="Copy the Native Webhook URL">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>After linking your account in StackOne, a <strong>Native Webhook URL</strong> is generated for that linked account.</p>

        <ul>
          <li>Open <strong>Linked Accounts</strong> in StackOne and click <strong>Edit</strong> on your GitHub account</li>
          <li>Copy the <strong>Native Webhook URL</strong> from the Configuration form</li>
          <li>Note: The URL is unique to this linked account. Do not reuse it for another account.</li>
        </ul>
      </div>
    </Step>

    <Step title="Open the Repository Webhook Settings">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Navigate to the webhook settings of the repository or organisation you wish to receive events from.</p>

        <ul>
          <li>Open the repository in your organisation on GitHub</li>
          <li>Click the <strong>Settings</strong> tab</li>
          <li>In the left sidebar, under <strong>Code, planning, and automation</strong>, click <strong>Webhooks</strong></li>
          <li>Click <strong>Add webhook</strong></li>
        </ul>
      </div>
    </Step>

    <Step title="Configure the Payload">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Point the webhook at StackOne and send the payload as JSON.</p>

        <ul>
          <li>Paste the copied <strong>Native Webhook URL</strong> into the <strong>Payload URL</strong> field</li>
          <li>Set <strong>Content type</strong> to <strong>application/json</strong></li>
          <li>Leave the <strong>Secret</strong> field empty</li>
          <li>Keep <strong>Enable SSL verification</strong> selected</li>
        </ul>
      </div>
    </Step>

    <Step title="Select the Events to Send">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Under <strong>Which events would you like to trigger this webhook?</strong>, choose <strong>Let me select individual events</strong>, then select the events you wish to receive.</p>

        <ul>
          <li>- <strong>Branch or tag creation</strong>: Branch or tag created.</li>
          <li>- <strong>Branch or tag deletion</strong>: Branch or tag deleted.</li>
          <li>- <strong>Check runs</strong>: Check run is created, requested, rerequested, or completed.</li>
          <li>- <strong>Check suites</strong>: Check suite is requested, rerequested, or completed.</li>
          <li>- <strong>Code scanning alerts</strong>: Code scanning alert updated. Triggered when the assignees or state of the alert changes. The state can be created, fixed in branch, or closed.</li>
          <li>- <strong>Commit comments</strong>: Commit or diff commented on.</li>
          <li>- <strong>Dependabot alerts</strong>: Dependabot alert assignees changed, auto dismissed, auto reopened, created, dismissed, reopened, fixed, or reintroduced.</li>
          <li>- <strong>Deployment statuses</strong>: Deployment status updated from the API.</li>
          <li>- <strong>Deployments</strong>: Repository was deployed or a deployment was deleted.</li>
          <li>- <strong>Forks</strong>: Repository forked.</li>
          <li>- <strong>Issue comments</strong>: Issue comment created, edited, or deleted.</li>
          <li>- <strong>Issues</strong>: Issue opened, edited, deleted, transferred, pinned, unpinned, closed, reopened, assigned, unassigned, labeled, unlabeled, milestoned, demilestoned, locked, unlocked, typed, untyped, field added, or field removed.</li>
          <li>- <strong>Pull request review comments</strong>: Pull request diff comment created, edited, or deleted.</li>
          <li>- <strong>Pull request reviews</strong>: Pull request review submitted, edited, or dismissed.</li>
          <li>- <strong>Pull requests</strong>: Pull request assigned, auto merge disabled, auto merge enabled, closed, converted to draft, demilestoned, dequeued, edited, enqueued, labeled, locked, milestoned, opened, ready for review, reopened, review request removed, review requested, stacked, synchronized, unassigned, unlabeled, or unlocked.</li>
          <li>- <strong>Pushes</strong>: Git push to a repository.</li>
          <li>- <strong>Releases</strong>: Release created, edited, published, unpublished, or deleted.</li>
          <li>- <strong>Repositories</strong>: Repository created, deleted, archived, unarchived, publicized, privatized, edited, renamed, or transferred.</li>
          <li>- <strong>Secret scanning alerts</strong>: Secret scanning alert created, resolved, reopened, validated, publicly leaked, assigned, or unassigned.</li>
          <li>- <strong>Stars</strong>: A star is created or deleted from a repository.</li>
          <li>- <strong>Statuses</strong>: Commit status updated from the API.</li>
          <li>- <strong>Team adds</strong>: Team added or modified on a repository.</li>
          <li>- <strong>Workflow jobs</strong>: Workflow job queued, waiting, in progress, or completed on a repository.</li>
          <li>- <strong>Workflow runs</strong>: Workflow run requested or completed on a repository.</li>
        </ul>

        <img src="https://mintcdn.com/stackone-60/T7KTxzGb98DXtxyr/connectors/github/images/github-repo-webhook-form.png?fit=max&auto=format&n=T7KTxzGb98DXtxyr&q=85&s=59c4be912e508cdc9c1e5aaeecb81f84" alt="GitHub repository webhook form" width="1146" height="1359" data-path="connectors/github/images/github-repo-webhook-form.png" />
      </div>
    </Step>

    <Step title="Activate the Webhook">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Save the webhook to begin receiving events.</p>

        <ul>
          <li>Select <strong>Active</strong> to enable the webhook</li>
          <li>Click <strong>Add webhook</strong></li>
          <li>Reconnect the account in StackOne so the new configuration is applied</li>
        </ul>
      </div>
    </Step>
  </Steps>
</section>

## Verify

Your Connector should now be able to receive and process events. Try triggering an event and you should see an Event appear in the Connector logs.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.