Reviewing the audit log for your organization

The audit log allows organization admins to quickly review the actions performed by members of your organization. It includes details such as who performed the action, what the action was, and when it was performed.

In this article

Accessing the audit log

The audit log lists events triggered by activities that affect your organization within the last 90 days. Only owners can access an organization's audit log.

  1. In the top right corner of GitHub, click your profile photo, then click Your organizations. Your organizations in the profile menu
  2. Next to the organization, click Settings. The settings button
  3. In the Settings sidebar, click Audit log. Org audit log settings in sidebar

Searching the audit log

The log lists the following information about each action:

  • Which repository an action was performed in
  • The user that performed the action
  • The action that was performed
  • Which country the action took place in
  • The date and time the action occurred

Note that you cannot search for entries using text. You can, however, construct search queries using a variety of filters. Many operators used when querying the log, such as -, >, or <, match the same format as searching across GitHub. For more information, see "Searching on GitHub."

Search based on operation

Use the operation qualifier to limit actions to specific types of operations. For example:

  • operation:access finds all events where a resource was accessed.
  • operation:authentication finds all events where an authentication event was performed.
  • operation:create finds all events where a resource was created.
  • operation:modify finds all events where an existing resource was modified.
  • operation:remove finds all events where an existing resource was removed.
  • operation:restore finds all events where an existing resource was restored.
  • operation:transfer finds all events where an existing resource was transferred.

Search based on repository

Use the repo qualifier to limit actions to a specific repository. For example:

  • repo:my-org/our-repo finds all events that occurred for the our-repo repository in the my-org organization.
  • repo:my-org/our-repo repo:my-org/another-repo finds all events that occurred for both the our-repo and another-repo repositories in the my-org organization.
  • -repo:my-org/not-this-repo excludes all events that occurred for the not-this-repo repository in the my-org organization.

Note that you must include the account name within the repo qualifier; searching for just repo:our-repo will not work.

Search based on the user

The actor qualifier can scope events based on who performed the action. For example:

  • actor:octocat finds all events performed by octocat.
  • actor:octocat actor:hubot finds all events performed by both octocat and hubot.
  • -actor:hubot excludes all events performed by hubot.

Note that you can only use a GitHub username, not an individual's real name.

Search based on the action performed

To search for specific events, use the action qualifier in your query. Actions listed in the audit log are grouped within the following categories:

Category nameDescription
accountContains all activities related to your organization account.
advisory_creditContains all activities related to crediting a contributor for a security advisory in the GitHub Advisory Database. For more information, see "About GitHub Security Advisories."
billingContains all activities related to your organization's billing.
businessContains activities related to business settings for an enterprise.
codespacesContains all activities related to your organization's codespaces.
dependabot_alertsContains organization-level configuration activities for Dependabot alerts in existing repositories. For more information, see "About alerts for vulnerable dependencies."
dependabot_alerts_new_reposContains organization-level configuration activities for Dependabot alerts in new repositories created in the organization.
dependabot_security_updatesContains organization-level configuration activities for Dependabot security updates in existing repositories. For more information, see "Configuring Dependabot security updates."
dependabot_security_updates_new_reposContains organization-level configuration activities for Dependabot security updates for new repositories created in the organization.
dependency_graphContains organization-level configuration activities for dependency graphs for repositories. For more information, see "About the dependency graph."
dependency_graph_new_reposContains organization-level configuration activities for new repositories created in the organization.
discussion_postContains all activities related to discussions posted to a team page.
discussion_post_replyContains all activities related to replies to discussions posted to a team page.
enterpriseContains activities related to enterprise settings.
hookContains all activities related to webhooks.
integration_installation_requestContains all activities related to organization member requests for owners to approve integrations for use in the organization.
issueContains activities related to deleting an issue.
marketplace_agreement_signatureContains all activities related to signing the GitHub Marketplace Developer Agreement.
marketplace_listingContains all activities related to listing apps in GitHub Marketplace.
members_can_create_pagesContains all activities related to managing the publication of GitHub Pages sites for repositories in the organization. For more information, see "Managing the publication of GitHub Pages sites for your organization."
orgContains activities related to organization membership.
org_credential_authorizationContains all activities related to authorizing credentials for use with SAML single sign-on.
organization_labelContains all activities related to default labels for repositories in your organization.
oauth_applicationContains all activities related to OAuth Apps.
packagesContains all activities related to GitHub Packages.
payment_methodContains all activities related to how your organization pays for GitHub.
profile_pictureContains all activities related to your organization's profile picture.
projectContains all activities related to project boards.
protected_branchContains all activities related to protected branches.
repoContains activities related to the repositories owned by your organization.
repository_advisoryContains repository-level activities related to security advisories in the GitHub Advisory Database. For more information, see "About GitHub Security Advisories."
repository_content_analysisContains all activities related to enabling or disabling data use for a private repository.
repository_dependency_graphContains repository-level activities related to enabling or disabling the dependency graph for a private repository. For more information, see "About the dependency graph."
repository_secret_scanningContains repository-level activities related to secret scanning. For more information, see "About secret scanning."
repository_vulnerability_alertContains all activities related to Dependabot alerts for vulnerable dependencies.
repository_vulnerability_alertsContains repository-level configuration activities for Dependabot alerts.
secret_scanningContains organization-level configuration activities for secret scanning in existing repositories. For more information, see "About secret scanning."
secret_scanning_new_reposContains organization-level configuration activities for secret scanning for new repositories created in the organization.
sponsorsContains all events related to sponsor buttons (see "Displaying a sponsor button in your repository")
teamContains all activities related to teams in your organization.
team_discussionsContains activities related to managing team discussions for an organization.

You can search for specific sets of actions using these terms. For example:

  • action:team finds all events grouped within the team category.
  • -action:hook excludes all events in the webhook category.

Each category has a set of associated actions that you can filter on. For example:

  • action:team.create finds all events where a team was created.
  • -action:hook.events_changed excludes all events where the events on a webhook have been altered.

Search based on time of action

Use the created qualifier to filter events in the audit log based on when they occurred. Date formatting must follow the ISO8601 standard, which is YYYY-MM-DD (year-month-day). You can also add optional time information THH:MM:SS+00:00 after the date, to search by the hour, minute, and second. That's T, followed by HH:MM:SS (hour-minutes-seconds), and a UTC offset (+00:00).

When you search for a date, you can use greater than, less than, and range qualifiers to further filter results. For more information, see "Understanding the search syntax."

For example:

  • created:2014-07-08 finds all events that occurred on July 8th, 2014.
  • created:>=2014-07-08 finds all events that occurred on or after July 8th, 2014.
  • created:<=2014-07-08 finds all events that occurred on or before July 8th, 2014.
  • created:2014-07-01..2014-07-31 finds all events that occurred in the month of July 2014.

The audit log contains data for the past 90 days, but you can use the created qualifier to search for events earlier than that.

Search based on location

Using the qualifier country, you can filter events in the audit log based on the originating country. You can use a country's two-letter short code or its full name. Keep in mind that countries with spaces in their name will need to be wrapped in quotation marks. For example:

  • country:de finds all events that occurred in Germany.
  • country:Mexico finds all events that occurred in Mexico.
  • country:"United States" all finds events that occurred in the United States.

Exporting the audit log

You can export the log as JSON data or a comma-separated value (CSV) file.

Export button

To filter the results in your export, search by one or more of these supported qualifiers before using the Export drop-down menu.

QualifierExample value
actionteam.create
actoroctocat
usercodertocat
orgocto-org
repoocto-org/documentation
created2019-06-01

After you export the log as JSON or CSV, you'll see the following keys and values in the resulting file.

KeyExample value
actionteam.create
actoroctocat
usercodertocat
orgocto-org
repoocto-org/documentation
created_at1429548104000 (Timestamp shows the time since Epoch with milliseconds.)
data.hook_id245
data.events["issues", "issue_comment", "pull_request", "pull_request_review_comment"]
data.events_were["push", "pull_request", "issues"]
data.target_loginoctocat
data.old_userhubot
data.teamocto-org/engineering

Using the audit log API

You can interact with the audit log using the GraphQL API or the REST API.

The audit log API requires GitHub Enterprise Cloud. For more information about how you can try GitHub Enterprise Cloud for free, see "Setting up a trial of GitHub Enterprise Cloud."

Using the GraphQL API

Note: The audit log GraphQL API is available for organizations using GitHub Enterprise. For more information, see "GitHub's products."

To ensure your intellectual property is secure, and you maintain compliance for your organization, you can use the audit log GraphQL API to keep copies of your audit log data and monitor:

  • Access to your organization or repository settings
  • Changes in permissions
  • Added or removed users in an organization, repository, or team
  • Users being promoted to admin
  • Changes to permissions of a GitHub App

Note that you can't retrieve Git events using the GraphQL API. To retrieve Git events, use the REST API instead. For more information, see "git category actions."

The GraphQL response can include data for up to 90 to 120 days.

For example, you can make a GraphQL request to see all the new organization members added to your organization. For more information, see the "GraphQL API Audit Log."

Using the REST API

Note: The audit log REST API is available for users of GitHub Enterprise Cloud only.

To ensure your intellectual property is secure, and you maintain compliance for your organization, you can use the audit log REST API to keep copies of your audit log data and monitor:

  • Access to your organization or repository settings
  • Changes in permissions
  • Added or removed users in an organization, repository, or team
  • Users being promoted to admin
  • Changes to permissions of a GitHub App
  • Git events, such as cloning, fetching, and pushing

The audit log retains Git events for 7 days. This is shorter than other audit log events, which can be retained for 90 days.

For more information about the audit log REST API, see "Organizations."

Audit log actions

An overview of some of the most common actions that are recorded as events in the audit log.

account category actions

ActionDescription
billing_plan_changeTriggered when an organization's billing cycle changes.
plan_changeTriggered when an organization's subscription changes.
pending_plan_changeTriggered when an organization owner or billing manager cancels or downgrades a paid subscription.
pending_subscription_changeTriggered when a GitHub Marketplace free trial starts or expires.

advisory_credit category actions

ActionDescription
acceptTriggered when someone accepts credit for a security advisory. For more information, see "Editing a security advisory."
createTriggered when the administrator of a security advisory adds someone to the credit section.
declineTriggered when someone declines credit for a security advisory.
destroyTriggered when the administrator of a security advisory removes someone from the credit section.

billing category actions

ActionDescription
change_billing_typeTriggered when your organization changes how it pays for GitHub.
change_emailTriggered when your organization's billing email address changes.

business category actions

ActionDescription
set_actions_fork_pr_approvals_policyTriggered when the setting for requiring approvals for workflows from public forks is changed for an enterprise. For more information, see "Requiring approval for workflows from public forks."
set_actions_retention_limitTriggered when the retention period for GitHub Actions artifacts and logs is changed for an enterprise. For more information, see "Configuring the retention period for GitHub Actions artifacts and logs in your enterprise account."
set_fork_pr_workflows_policyTriggered when the policy for workflows on private repository forks is changed. For more information, see "Enabling workflows for private repository forks."

codespaces category actions

ActionDescription
createTriggered when a user creates a codespace.
resumeTriggered when a user resumes a suspended codespace.
deleteTriggered when a user deletes a codespace.
create_an_org_secretTriggered when a user creates an organization-level secret for Codespaces
update_an_org_secretTriggered when a user updates an organization-level secret for Codespaces.
remove_an_org_secretTriggered when a user removes an organization-level secret for Codespaces.
manage_access_and_securityTriggered when a user updates which repositories a codespace can access.

dependabot_alerts category actions

ActionDescription
disableTriggered when an organization owner disables Dependabot alerts for all existing private repositories. For more information, see "Managing security and analysis settings for your organization."
enableTriggered when an organization owner enables Dependabot alerts for all existing private repositories.

dependabot_alerts_new_repos category actions

ActionDescription
disableTriggered when an organization owner disables Dependabot alerts for all new private repositories. For more information, see "Managing security and analysis settings for your organization."
enableTriggered when an organization owner enables Dependabot alerts for all new private repositories.

dependabot_security_updates category actions

ActionDescription
disableTriggered when an organization owner disables Dependabot security updates for all existing repositories. For more information, see "Managing security and analysis settings for your organization."
enableTriggered when an organization owner enables Dependabot security updates for all existing repositories.

dependabot_security_updates_new_repos category actions

ActionDescription
disableTriggered when an organization owner disables Dependabot security updates for all new repositories. For more information, see "Managing security and analysis settings for your organization."
enableTriggered when an organization owner enables Dependabot security updates for all new repositories.

dependency_graph category actions

ActionDescription
disableTriggered when an organization owner disables the dependency graph for all existing repositories. For more information, see "Managing security and analysis settings for your organization."
enableTriggered when an organization owner enables the dependency graph for all existing repositories.

dependency_graph_new_repos category actions

ActionDescription
disableTriggered when an organization owner disables the dependency graph for all new repositories. For more information, see "Managing security and analysis settings for your organization."
enableTriggered when an organization owner enables the dependency graph for all new repositories.

discussion_post category actions

ActionDescription
updateTriggered when a team discussion post is edited.
destroyTriggered when a team discussion post is deleted.

discussion_post_reply category actions

ActionDescription
updateTriggered when a reply to a team discussion post is edited.
destroyTriggered when a reply to a team discussion post is deleted.

enterprise category actions

ActionDescription
remove_self_hosted_runnerTriggered when a self-hosted runner is removed.
register_self_hosted_runnerTriggered when a new self-hosted runner is registered. For more information, see "Adding self-hosted runners."
runner_group_createdTriggered when a self-hosted runner group is created. For more information, see "About self-hosted runner groups.
runner_group_removedTriggered when a self-hosted runner group is removed. For more information, see "Removing a self-hosted runner group."
runner_group_runner_removedTriggered when the REST API is used to remove a self-hosted runner from a group.
runner_group_runners_addedTriggered when a self-hosted runner is added to a group. For more information, see "Moving a self-hosted runner to a group."
runner_group_runners_updatedTriggered when a runner group's list of members is updated. For more information, see "Set self-hosted runners in a group for an organization."
runner_group_updatedTriggered when the configuration of a self-hosted runner group is changed. For more information, see "Changing the access policy of a self-hosted runner group."
self_hosted_runner_updatedTriggered when the runner application is updated. Can be viewed using the REST API and the UI; not visible in the JSON/CSV export. For more information, see "About self-hosted runners."
self_hosted_runner_onlineTriggered when the runner application is started. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "Checking the status of a self-hosted runner."
self_hosted_runner_offlineTriggered when the runner application is stopped. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "Checking the status of a self-hosted runner."

environment category actions

ActionDescription
create_actions_secretTriggered when a secret is created in an environment. For more information, see "Environment secrets."
deleteTriggered when an environment is deleted. For more information, see "Deleting an environment."
remove_actions_secretTriggered when a secret is removed from an environment. For more information, see "Environment secrets."
update_actions_secretTriggered when a secret in an environment is updated. For more information, see "Environment secrets."

git category actions

Note: To access Git events in the audit log, you must use the audit log REST API. The audit log REST API is available for users of GitHub Enterprise Cloud only. For more information, see "Organizations."

The audit log retains Git events for 7 days. This is shorter than other audit log events, which can be retained for 90 days.

ActionDescription
cloneTriggered when a repository is cloned.
fetchTriggered when changes are fetched from a repository.
pushTriggered when changes are pushed to a repository.

hook category actions

ActionDescription
createTriggered when a new hook was added to a repository owned by your organization.
config_changedTriggered when an existing hook has its configuration altered.
destroyTriggered when an existing hook was removed from a repository.
events_changedTriggered when the events on a hook have been altered.

integration_installation_request category actions

ActionDescription
createTriggered when an organization member requests that an organization owner install an integration for use in the organization.
closeTriggered when a request to install an integration for use in an organization is either approved or denied by an organization owner, or canceled by the organization member who opened the request.

issue category actions

ActionDescription
destroyTriggered when an organization owner or someone with admin permissions in a repository deletes an issue from an organization-owned repository.

marketplace_agreement_signature category actions

ActionDescription
createTriggered when you sign the GitHub Marketplace Developer Agreement.

marketplace_listing category actions

ActionDescription
approveTriggered when your listing is approved for inclusion in GitHub Marketplace.
createTriggered when you create a listing for your app in GitHub Marketplace.
delistTriggered when your listing is removed from GitHub Marketplace.
redraftTriggered when your listing is sent back to draft state.
rejectTriggered when your listing is not accepted for inclusion in GitHub Marketplace.

members_can_create_pages category actions

For more information, see "Managing the publication of GitHub Pages sites for your organization."

ActionDescription
enableTriggered when an organization owner enables publication of GitHub Pages sites for repositories in the organization.
disableTriggered when an organization owner disables publication of GitHub Pages sites for repositories in the organization.

org category actions

ActionDescription
add_memberTriggered when a user joins an organization.
advanced_security_policy_selected_member_disabledTriggered when an enterprise owner prevents GitHub Advanced Security features from being enabled for repositories owned by the organization. For more information, see "Enforcing policies for Advanced Security in your enterprise account."
advanced_security_policy_selected_member_enabledTriggered when an enterprise owner allows GitHub Advanced Security features to be enabled for repositories owned by the organization. For more information, see "Enforcing policies for Advanced Security in your enterprise account."
audit_log_exportTriggered when an organization admin creates an export of the organization audit log. If the export included a query, the log will list the query used and the number of audit log entries matching that query.
block_userTriggered when an organization owner blocks a user from accessing the organization's repositories.
cancel_invitationTriggered when an organization invitation has been revoked.
create_actions_secretTriggered when a GitHub Actions secret is created for an organization. For more information, see "Creating encrypted secrets for an organization."
disable_oauth_app_restrictionsTriggered when an owner disables OAuth App access restrictions for your organization.
disable_samlTriggered when an organization admin disables SAML single sign-on for an organization.
disable_member_team_creation_permissionTriggered when an organization owner limits team creation to owners. For more information, see "Setting team creation permissions in your organization."
disable_two_factor_requirementTriggered when an owner disables a two-factor authentication requirement for all members, billing managers, and outside collaborators in an organization.
enable_oauth_app_restrictionsTriggered when an owner enables OAuth App access restrictions for your organization.
enable_samlTriggered when an organization admin enables SAML single sign-on for an organization.
enable_member_team_creation_permissionTriggered when an organization owner allows members to create teams. For more information, see "Setting team creation permissions in your organization."
enable_two_factor_requirementTriggered when an owner requires two-factor authentication for all members, billing managers, and outside collaborators in an organization.
invite_memberTriggered when a new user was invited to join your organization.
oauth_app_access_approvedTriggered when an owner grants organization access to an OAuth App.
oauth_app_access_deniedTriggered when an owner disables a previously approved OAuth App's access to your organization.
oauth_app_access_requestedTriggered when an organization member requests that an owner grant an OAuth App access to your organization.
register_self_hosted_runnerTriggered when a new self-hosted runner is registered. For more information, see "Adding a self-hosted runner to an organization."
remove_actions_secretTriggered when a GitHub Actions secret is removed.
remove_billing_managerTriggered when an owner removes a billing manager from an organization or when two-factor authentication is required in an organization and a billing manager doesn't use 2FA or disables 2FA.
remove_memberTriggered when an owner removes a member from an organization or when two-factor authentication is required in an organization and an organization member doesn't use 2FA or disables 2FA. Also triggered when an organization member removes themselves from an organization.
remove_outside_collaboratorTriggered when an owner removes an outside collaborator from an organization or when two-factor authentication is required in an organization and an outside collaborator does not use 2FA or disables 2FA.
remove_self_hosted_runnerTriggered when a self-hosted runner is removed. For more information, see "Removing a runner from an organization."
revoke_external_identityTriggered when an organization owner revokes a member's linked identity. For more information, see "Viewing and managing a member's SAML access to your organization."
revoke_sso_sessionTriggered when an organization owner revokes a member's SAML session. For more information, see "Viewing and managing a member's SAML access to your organization."
runner_group_createdTriggered when a self-hosted runner group is created. For more information, see "Creating a self-hosted runner group for an organization."
runner_group_removedTriggered when a self-hosted runner group is removed. For more information, see "Removing a self-hosted runner group."
runner_group_updatedTriggered when the configuration of a self-hosted runner group is changed. For more information, see "Changing the access policy of a self-hosted runner group."
runner_group_runners_addedTriggered when a self-hosted runner is added to a group. For more information, see Moving a self-hosted runner to a group.
runner_group_runner_removedTriggered when the REST API is used to remove a self-hosted runner from a group. For more information, see "Remove a self-hosted runner from a group for an organization."
runner_group_runners_updatedTriggered when a runner group's list of members is updated. For more information, see "Set self-hosted runners in a group for an organization."
self_hosted_runner_onlineTriggered when the runner application is started. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "Checking the status of a self-hosted runner."
self_hosted_runner_offlineTriggered when the runner application is stopped. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "Checking the status of a self-hosted runner."
self_hosted_runner_updatedTriggered when the runner application is updated. Can be viewed using the REST API and the UI; not visible in the JSON/CSV export. For more information, see "About self-hosted runners."
set_actions_fork_pr_approvals_policyTriggered when the setting for requiring approvals for workflows from public forks is changed for an organization. For more information, see "Requiring approval for workflows from public forks."
set_actions_retention_limitTriggered when the retention period for GitHub Actions artifacts and logs is changed. For more information, see "Configuring the retention period for GitHub Actions artifacts and logs in your organization."
set_fork_pr_workflows_policyTriggered when the policy for workflows on private repository forks is changed. For more information, see "Enabling workflows for private repository forks."
unblock_userTriggered when an organization owner unblocks a user from an organization.
update_actions_secretTriggered when a GitHub Actions secret is updated.
update_new_repository_default_branch_settingTriggered when an owner changes the name of the default branch for new repositories in the organization. For more information, see "Managing the default branch name for repositories in your organization."
update_default_repository_permissionTriggered when an owner changes the default repository permission level for organization members.
update_memberTriggered when an owner changes a person's role from owner to member or member to owner.
update_member_repository_creation_permissionTriggered when an owner changes the create repository permission for organization members.
update_saml_provider_settingsTriggered when an organization's SAML provider settings are updated.
update_terms_of_serviceTriggered when an organization changes between the Standard Terms of Service and the Corporate Terms of Service. For more information, see "Upgrading to the Corporate Terms of Service."

org_credential_authorization category actions

ActionDescription
grantTriggered when a member authorizes credentials for use with SAML single sign-on.
deauthorizedTriggered when a member deauthorizes credentials for use with SAML single sign-on.
revokeTriggered when an owner revokes authorized credentials.

organization_label category actions

ActionDescription
createTriggered when a default label is created.
updateTriggered when a default label is edited.
destroyTriggered when a default label is deleted.

oauth_application category actions

ActionDescription
createTriggered when a new OAuth App is created.
destroyTriggered when an existing OAuth App is deleted.
reset_secretTriggered when an OAuth App's client secret is reset.
revoke_tokensTriggered when an OAuth App's user tokens are revoked.
transferTriggered when an existing OAuth App is transferred to a new organization.

packages category actions

ActionDescription
package_version_publishedTriggered when a package version is published.
package_version_deletedTriggered when a specific package version is deleted. For more information, see "Deleting and restoring a package."
package_deletedTriggered when an entire package is deleted. For more information, see "Deleting and restoring a package."
package_version_restoredTriggered when a specific package version is deleted. For more information, see "Deleting and restoring a package."
package_restoredTriggered when an entire package is restored. For more information, see "Deleting and restoring a package."

payment_method category actions

ActionDescription
clearTriggered when a payment method on file is removed.
createTriggered when a new payment method is added, such as a new credit card or PayPal account.
updateTriggered when an existing payment method is updated.

profile_picture category actions

ActionDescription
updateTriggered when you set or update your organization's profile picture.

project category actions

ActionDescription
createTriggered when a project board is created.
linkTriggered when a repository is linked to a project board.
renameTriggered when a project board is renamed.
updateTriggered when a project board is updated.
deleteTriggered when a project board is deleted.
unlinkTriggered when a repository is unlinked from a project board.
update_org_permissionTriggered when the base-level permission for all organization members is changed or removed.
update_team_permissionTriggered when a team's project board permission level is changed or when a team is added or removed from a project board.
update_user_permissionTriggered when an organization member or outside collaborator is added to or removed from a project board or has their permission level changed.

protected_branch category actions

ActionDescription
create Triggered when branch protection is enabled on a branch.
destroyTriggered when branch protection is disabled on a branch.
update_admin_enforced Triggered when branch protection is enforced for repository administrators.
update_require_code_owner_review Triggered when enforcement of required Code Owner review is updated on a branch.
dismiss_stale_reviews Triggered when enforcement of dismissing stale pull requests is updated on a branch.
update_signature_requirement_enforcement_level Triggered when enforcement of required commit signing is updated on a branch.
update_pull_request_reviews_enforcement_level Triggered when enforcement of required pull request reviews is updated on a branch.
update_required_status_checks_enforcement_level Triggered when enforcement of required status checks is updated on a branch.
update_strict_required_status_checks_policyTriggered when the requirement for a branch to be up to date before merging is changed.
rejected_ref_update Triggered when a branch update attempt is rejected.
policy_override Triggered when a branch protection requirement is overridden by a repository administrator.
update_allow_force_pushes_enforcement_level Triggered when force pushes are enabled or disabled for a protected branch.
update_allow_deletions_enforcement_level Triggered when branch deletion is enabled or disabled for a protected branch.
update_linear_history_requirement_enforcement_level Triggered when required linear commit history is enabled or disabled for a protected branch.

pull_request category actions

ActionDescription
createTriggered when a pull request is created.
closeTriggered when a pull request is closed without being merged.
reopenTriggered when a pull request is reopened after previously being closed.
mergeTriggered when a pull request is merged.
indirect_mergeTriggered when a pull request is considered merged because its commits were merged into the target branch.
ready_for_reviewTriggered when a pull request is marked as ready for review.
converted_to_draftTriggered when a pull request is converted to a draft.
create_review_requestTriggered when a review is requested.
remove_review_requestTriggered when a review request is removed.

pull_request_review category actions

ActionDescription
submitTriggered when a review is submitted.
dismissTriggered when a review is dismissed.
deleteTriggered when a review is deleted.

pull_request_review_comment category actions

ActionDescription
createTriggered when a review comment is added.
updateTriggered when a review comment is changed.
deleteTriggered when a review comment is deleted.

repo category actions

ActionDescription
accessTriggered when a user changes the visibility of a repository in the organization.
actions_enabledTriggered when GitHub Actions is enabled for a repository. Can be viewed using the UI. This event is not included when you access the audit log using the REST API. For more information, see "Using the REST API."
add_memberTriggered when a user accepts an invitation to have collaboration access to a repository.
add_topicTriggered when a repository admin adds a topic to a repository.
advanced_security_disabledTriggered when a repository administrator disables GitHub Advanced Security features for the repository. For more information, see "Managing security and analysis settings for your repository."
advanced_security_enabledTriggered when a repository administrator enables GitHub Advanced Security features for the repository. For more information, see "Managing security and analysis settings for your repository.".
archivedTriggered when a repository admin archives a repository.
createTriggered when a new repository is created.
create_actions_secretTriggered when a GitHub Actions secret is created for a repository. For more information, see "Creating encrypted secrets for a repository."
destroyTriggered when a repository is deleted.
disableTriggered when a repository is disabled (e.g., for insufficient funds).
enableTriggered when a repository is re-enabled.
remove_actions_secretTriggered when a GitHub Actions secret is removed.
remove_memberTriggered when a user is removed from a repository as a collaborator.
register_self_hosted_runnerTriggered when a new self-hosted runner is registered. For more information, see "Adding a self-hosted runner to a repository."
remove_self_hosted_runnerTriggered when a self-hosted runner is removed. For more information, see "Removing a runner from a repository."
remove_topicTriggered when a repository admin removes a topic from a repository.
renameTriggered when a repository is renamed.
self_hosted_runner_onlineTriggered when the runner application is started. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "Checking the status of a self-hosted runner."
self_hosted_runner_offlineTriggered when the runner application is stopped. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "Checking the status of a self-hosted runner."
self_hosted_runner_updatedTriggered when the runner application is updated. Can be viewed using the REST API and the UI; not visible in the JSON/CSV export. For more information, see "About self-hosted runners."
set_actions_fork_pr_approvals_policyTriggered when the setting for requiring approvals for workflows from public forks is changed. For more information, see "Requiring approval for workflows from public forks."
set_actions_retention_limitTriggered when the retention period for GitHub Actions artifacts and logs is changed. For more information, see "Configuring the retention period for GitHub Actions artifacts and logs in your repository."
set_fork_pr_workflows_policyTriggered when the policy for workflows on private repository forks is changed. For more information, see "Enabling workflows for private repository forks."
transferTriggered when a repository is transferred.
transfer_startTriggered when a repository transfer is about to occur.
unarchivedTriggered when a repository admin unarchives a repository.
update_actions_secretTriggered when a GitHub Actions secret is updated.

repository_advisory category actions

ActionDescription
closeTriggered when someone closes a security advisory. For more information, see "About GitHub Security Advisories."
cve_requestTriggered when someone requests a CVE (Common Vulnerabilities and Exposures) number from GitHub for a draft security advisory.
github_broadcastTriggered when GitHub makes a security advisory public in the GitHub Advisory Database.
github_withdrawTriggered when GitHub withdraws a security advisory that was published in error.
openTriggered when someone opens a draft security advisory.
publishTriggered when someone publishes a security advisory.
reopenTriggered when someone reopens as draft security advisory.
updateTriggered when someone edits a draft or published security advisory.

repository_content_analysis category actions

ActionDescription
enableTriggered when an organization owner or person with admin access to the repository enables data use settings for a private repository.
disableTriggered when an organization owner or person with admin access to the repository disables data use settings for a private repository.

repository_dependency_graph category actions

ActionDescription
disableTriggered when a repository owner or person with admin access to the repository disables the dependency graph for a private repository. For more information, see "About the dependency graph."
enableTriggered when a repository owner or person with admin access to the repository enables the dependency graph for a private repository.

repository_secret_scanning category actions

ActionDescription
disableTriggered when a repository owner or person with admin access to the repository disables secret scanning for a private repository. For more information, see "About secret scanning."
enableTriggered when a repository owner or person with admin access to the repository enables secret scanning for a private repository.

repository_vulnerability_alert category actions

ActionDescription
createTriggered when GitHub creates a Dependabot alert for a repository that uses a vulnerable dependency. For more information, see "About alerts for vulnerable dependencies."
dismissTriggered when an organization owner or person with admin access to the repository dismisses a Dependabot alert about a vulnerable dependency.
resolveTriggered when someone with write access to a repository pushes changes to update and resolve a vulnerability in a project dependency.

repository_vulnerability_alerts category actions

ActionDescription
authorized_users_teamsTriggered when an organization owner or a person with admin permissions to the repository updates the list of people or teams authorized to receive Dependabot alerts for vulnerable dependencies in the repository. For more information, see "Managing security and analysis settings for your repository."
disableTriggered when a repository owner or person with admin access to the repository disables Dependabot alerts.
enableTriggered when a repository owner or person with admin access to the repository enables Dependabot alerts.

secret_scanning category actions

ActionDescription
disableTriggered when an organization owner disables secret scanning for all existing, private repositories. For more information, see "About secret scanning."
enableTriggered when an organization owner enables secret scanning for all existing, private repositories.

secret_scanning_new_repos category actions

ActionDescription
disableTriggered when an organization owner disables secret scanning for all new private repositories. For more information, see "About secret scanning."
enableTriggered when an organization owner enables secret scanning for all new private repositories.

sponsors category actions

ActionDescription
custom_amount_settings_changeTriggered when you enable or disable custom amounts, or when you change the suggested custom amount (see "Managing your sponsorship tiers")
repo_funding_links_file_actionTriggered when you change the FUNDING file in your repository (see "Displaying a sponsor button in your repository")
sponsor_sponsorship_cancelTriggered when you cancel a sponsorship (see "Downgrading a sponsorship")
sponsor_sponsorship_createTriggered when you sponsor an account (see "Sponsoring an open source contributor")
sponsor_sponsorship_payment_completeTriggered after you sponsor an account and your payment has been processed (see "Sponsoring an open source contributor")
sponsor_sponsorship_preference_changeTriggered when you change whether you receive email updates from a sponsored account (see "Managing your sponsorship")
sponsor_sponsorship_tier_changeTriggered when you upgrade or downgrade your sponsorship (see "Upgrading a sponsorship" and "Downgrading a sponsorship")
sponsored_developer_approveTriggered when your GitHub Sponsors account is approved (see "Setting up GitHub Sponsors for your organization")
sponsored_developer_createTriggered when your GitHub Sponsors account is created (see "Setting up GitHub Sponsors for your organization")
sponsored_developer_disableTriggered when your GitHub Sponsors account is disabled
sponsored_developer_redraftTriggered when your GitHub Sponsors account is returned to draft state from approved state
sponsored_developer_profile_updateTriggered when you edit your sponsored organization profile (see "Editing your profile details for GitHub Sponsors")
sponsored_developer_request_approvalTriggered when you submit your application for GitHub Sponsors for approval (see "Setting up GitHub Sponsors for your organization")
sponsored_developer_tier_description_updateTriggered when you change the description for a sponsorship tier (see "Managing your sponsorship tiers")
sponsored_developer_update_newsletter_sendTriggered when you send an email update to your sponsors (see "Contacting your sponsors")
waitlist_invite_sponsored_developerTriggered when you are invited to join GitHub Sponsors from the waitlist (see "Setting up GitHub Sponsors for your organization")
waitlist_joinTriggered when you join the waitlist to become a sponsored organization (see "Setting up GitHub Sponsors for your organization")

team category actions

ActionDescription
add_memberTriggered when a member of an organization is added to a team.
add_repositoryTriggered when a team is given control of a repository.
change_parent_teamTriggered when a child team is created or a child team's parent is changed.
change_privacyTriggered when a team's privacy level is changed.
createTriggered when a new team is created.
demote_maintainerTriggered when a user was demoted from a team maintainer to a team member. For more information, see "Giving "team maintainer" permissions to an organization member."
destroyTriggered when a team is deleted from the organization.
team.promote_maintainerTriggered when a user was promoted from a team member to a team maintainer. For more information, see "Giving "team maintainer" permissions to an organization member."
remove_memberTriggered when a member of an organization is removed from a team.
remove_repositoryTriggered when a repository is no longer under a team's control.

team_discussions category actions

ActionDescription
disableTriggered when an organization owner disables team discussions for an organization. For more information, see "Disabling team discussions for your organization."
enableTriggered when an organization owner enables team discussions for an organization.

workflows category actions

ActionDescription
cancel_workflow_runTriggered when a workflow run has been cancelled. For more information, see "Canceling a workflow."
completed_workflow_runTriggered when a workflow status changes to completed. Can only be viewed using the REST API; not visible in the UI or the JSON/CSV export. For more information, see "Viewing workflow run history."
created_workflow_runTriggered when a workflow run is created. Can only be viewed using the REST API; not visible in the UI or the JSON/CSV export. For more information, see "Create an example workflow."
delete_workflow_runTriggered when a workflow run is deleted. For more information, see "Deleting a workflow run."
disable_workflowTriggered when a workflow is disabled.
enable_workflowTriggered when a workflow is enabled, after previously being disabled by disable_workflow.
rerun_workflow_runTriggered when a workflow run is re-run. For more information, see "Re-running a workflow."
prepared_workflow_jobTriggered when a workflow job is started. Includes the list of secrets that were provided to the job. Can only be viewed using the REST API; not visible in the UI or the JSON/CSV export. For more information, see "Events that trigger workflows."

Further reading

Did this doc help you?Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.