Configuring notifications

Notification delivery options

You can receive notifications for activity on GitHub in the following locations.

• The notifications inbox in the GitHub web interface
• The notifications inbox on GitHub Mobile, which syncs with the inbox in the web interface
• An email client that uses a verified email address, which can also sync with the notifications inbox in the web interface and GitHub Mobile

To use the notifications inbox on GitHub and GitHub Mobile, you must enable web and mobile notifications in your notification settings. For more information, see "Choosing your notification settings."

Benefits of the notifications inbox

The notifications inbox includes triaging options designed specifically for your GitHub notifications flow, including options to:

• Triage multiple notifications at once.
• Mark completed notifications as Done and remove them from your inbox. To view all of your notifications marked as Done, use the is:done query.
• Save a notification to review later. Saved notifications are flagged in your inbox and kept indefinitely. To view all of your saved notifications, use the is:saved query.
• Unsubscribe and remove a notification from your inbox.
• Preview the issue, pull request, or team discussion where the notification originates on GitHub from within the notifications inbox.
• See one of the latest reasons you're receiving a notification from your inbox with a reasons label.
• Create custom filters to focus on different notifications when you want.
• Group notifications in your inbox by repository or date to get a quick overview with less context switching.

In addition, you can receive and triage notifications on your mobile device with GitHub Mobile. For more information, see "Managing your notification settings with GitHub Mobile" or "GitHub Mobile."

Benefits of using an email client for notifications

One benefit of using an email client is that all of your notifications can be kept indefinitely depending on your email client's storage capacity. Your inbox notifications are only kept for 5 months on GitHub unless you've marked them as Saved. Saved notifications are kept indefinitely. For more information about your inbox's retention policy, see "About notifications."

Sending notifications to your email client also allows you to customize your inbox according to your email client's settings, which can include custom or color-coded labels.

Email notifications also allow flexibility with the types of notifications you receive and allow you to choose different email addresses for updates. For example, you can send certain notifications for a repository to a verified personal email address. For more information, about your email customization options, see "Customizing your email notifications."

About participating and watching notifications

When you watch a repository, you're subscribing to updates for activity in that repository. Similarly, when you watch a specific team's discussions, you're subscribing to all conversation updates on that team's page. For more information, see "About team discussions."

To see repositories that you're watching, go to your watching page. For more information, see "Managing subscriptions for activity on GitHub."

You can configure notifications for a repository on the repository page, or on your watching page.

About custom notifications

You can customize notifications for a repository. For example, you can choose to only be notified when updates to one or more types of events (issues, pull requests, releases, security alerts, or discussions) happen within a repository, or ignore all notifications for a repository. For more information, see "Configuring your watch settings for an individual repository" below.

Participating in conversations

Anytime you comment in a conversation or when someone @mentions your username, you are participating in a conversation. By default, you are automatically subscribed to a conversation when you participate in it. You can unsubscribe from a conversation you've participated in manually by clicking Unsubscribe on the issue or pull request or through the Unsubscribe option in the notifications inbox.

For conversations you're watching or participating in, you can choose whether you want to receive notifications by email or through the notifications inbox. For more information, see "Choosing your notification settings."

For example, on your "Notification settings" page:

• If you don't want notifications to be sent to your email, deselect email for participating and watching notifications.
• If you want to receive notifications by email when you've participated in a conversation, then select email under "Participating".

If you do not enable watching or participating notifications for web and mobile, then your notifications inbox will not have any updates.

Customizing your email notifications

After enabling email notifications, GitHub will send notifications to you as multipart emails that contain both HTML and plain text copies of the content. Email notification content includes any Markdown, @mentions, emojis, hash-links, and more, that appear in the original content on GitHub. If you only want to see the text in the email, you can configure your email client to display the plain text copy only.

Choose a default email address where you want to send updates for conversations you're participating in or watching. You can also specify which activity on GitHub you want to receive updates for using your default email address. For example, choose whether you want updates sent to your default email from:

• Comments on issues and pull requests
• Pull request reviews
• Pull request pushes
• Your own updates, such as when you open, comment on, or close an issue or pull request

Depending on the organization that owns the repository, you can also send notifications to different email addresses. Your organization may require the email address to be verified for a specific domain. For more information, see "Configuring notifications."

You can also send notifications for a specific repository to an email address. For more information, see "About email notifications for pushes to your repository."

You'll only receive notification emails if you've chosen to receive email notifications in your notification settings.

Filtering email notifications

Each email notification that GitHub sends contains header information. The header information in every email is consistent, so you can use it in your email client to filter or forward all GitHub notifications, or certain types of GitHub notifications.

If you believe you're receiving notifications that don't belong to you, examine the X-GitHub-Recipient and X-GitHub-Recipient-Address headers. These headers show who the intended recipient is. Depending on your email setup, you may receive notifications intended for another user.

Email notifications from GitHub contain header information.

Header	Information
From address	This address will always be 'the no-reply email address configured by your site administrator'.
To field	This field connects directly to the thread. If you reply to the email, you'll add a new comment to the conversation.
Cc address	GitHub Enterprise Server will Cc you if you're subscribed to a conversation. The second Cc email address matches the notification reason. The suffix for these notification reasons is based on the no-reply email address configured by your site administrator. The possible notification reasons are: assign: You were assigned to an issue or pull request. author: You created an issue or pull request. ci_activity: A GitHub Actions workflow run that you triggered was completed. comment: You commented on an issue or pull request. manual: There was an update to an issue or pull request you manually subscribed to. mention: You were mentioned on an issue or pull request. push: Someone committed to a pull request you're subscribed to. review_requested: You or a team you're a member of was requested to review a pull request. security_alert: GitHub detected a vulnerability in a repository you receive alerts for. state_change: An issue or pull request you're subscribed to was either closed or opened. subscribed: There was an update in a repository you're watching. team_mention: A team you belong to was mentioned on an issue or pull request. your_activity: You opened, commented on, or closed an issue or pull request.
List-Id field	This field identifies the name of the repository and its owner. The format of this address is always OWNER/REPOSITORY <REPOSITORY.OWNER>, e.g. List-Id: grain-lang/grain <grain.grain-lang.HOSTNAME>.
X-GitHub-Severity field	Email notifications for Dependabot alerts that affect one or more repositories include the X-GitHub-Severity header field. You can use the value of the X-GitHub-Severity header field to filter email notifications for Dependabot alerts. The possible severity levels are: low moderate high critical For more information, see "About Dependabot alerts."

Choosing your notification settings

1. In the upper-right corner of any page, click .

   

2. In the left sidebar, under the list of repositories, use the "Manage notifications" drop-down to click Notification settings.

   

3. On the notifications settings page, choose how you receive notifications when:

   • There are updates in repositories or team discussions you're watching or in a conversation you're participating in. For more information, see "About participating and watching notifications."
   • You gain access to a new repository or you've joined a new team. For more information, see "Automatic watching."
   • There are new Dependabot alerts in your repository. For more information, see "Dependabot alerts notification options."
   • There are new deploy keys added to repositories that belong to organizations that you're an owner of. For more information, see "Organization alerts notification options."

Automatic watching

By default, anytime you gain access to a new repository, you will automatically begin watching that repository. Anytime you join a new team, you will automatically be subscribed to updates and receive notifications when that team is @mentioned. If you don't want to automatically be subscribed, you can unselect the automatic watching options in your notification settings.

If "Automatically watch repositories" is disabled, then you will not automatically watch your own repositories. You must navigate to your repository page and choose the watch option.

For more information, see "Configuring notifications."

Configuring your watch settings for an individual repository

You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of certain event types such as issues, pull requests, releases, security alerts, or discussions (if enabled for the repository), or completely ignore an individual repository.

1. On your GitHub Enterprise Server instance, navigate to the main page of the repository.

2. In the upper-right corner, select the "Watch" drop-down menu, then click a watch option.

   If you want to further customize notifications, click Custom, then select specific events that you want to be notified of, such as Issues or Pull Requests, in addition to participating and @mentions.

   For example, if you select "Issues", you will be notified about, and subscribed to, updates on every issue (including those that existed prior to you selecting this option) in the repository. If you're @mentioned in a pull request in this repository, you'll receive notifications for that too, and you'll be subscribed to updates on that specific pull request, in addition to being notified about issues.

Choosing where your organization’s email notifications are sent

If you belong to an organization, you can choose the email account you want notifications for organization activity sent to. For example, if you belong to an organization for work, you may want your notifications sent to your work email address, rather than your personal address.

You'll only receive notification emails if you've chosen to receive email notifications in your notification settings.

1. In the upper-right corner of any page, click .

   

2. In the left sidebar, under the list of repositories, use the "Manage notifications" drop-down to click Notification settings.

   

3. Under "Default notifications email", select the email address you'd like notifications sent to.

4. Click Save.

Customizing email routes per organization

If you are a member of more than one organization, you can configure each one to send notifications to any of the email addresses for your account.

1. In the upper-right corner of any page, click .

   

2. In the left sidebar, under the list of repositories, use the "Manage notifications" drop-down to click Notification settings.

   

3. Under "Custom routing," find your organization's name in the list.

4. Click Edit next to the email address you want to change.

5. Select one of your verified email addresses, then click Save.

Dependabot alerts notification options

The notification options for your user account are available at https://github.com/settings/notifications. You can configure notification settings for each repository, in the repository watch settings.

To receive notifications about Dependabot alerts on repositories, you need to watch these repositories, and subscribe to receive "All Activity" notifications or configure custom settings to include "Security alerts." For more information, see "Configuring notifications." You can choose the delivery method for notifications, as well as the frequency at which the notifications are sent to you. By default, if your enterprise owner has configured email for notifications on your instance, you will receive Dependabot alerts:

• In your inbox, as web notifications. A web notification is sent when Dependabot is enabled for a repository, when a new manifest file is committed to the repository, and when a new vulnerability with a critical or high severity is found (On GitHub option).
• By email. An email is sent when Dependabot is enabled for a repository, when a new manifest file is committed to the repository, and when a new vulnerability with a critical or high severity is found (Email option).
• On the command line. Warnings are displayed as callbacks when you push to repositories with any insecure dependencies (CLI option).
• On GitHub Mobile, as web notifications. For more information, see "Configuring notifications."

You can customize the way you are notified about Dependabot alerts. For example, you can receive a weekly digest email summarizing alerts for up to 10 of your repositories using the Email a digest summary of vulnerabilities and Weekly security email digest options.

For more information about the notification delivery methods available to you, and advice on optimizing your notifications for Dependabot alerts, see "Configuring notifications for Dependabot alerts."

Secret scanning notification options

When a new secret is detected, GitHub Enterprise Server notifies all users with access to security alerts for the repository according to their notification preferences. These users include:

• Repository administrators
• Security managers
• Users with custom roles with read/write access
• Organization owners and enterprise owners, if they are administrators of repositories where secrets were leaked

You will receive an email notification if:

• You are watching the repository.
• You have enabled notifications for "All Activity", or for custom "Security alerts" on the repository.
• In your notification settings, under "Subscriptions", then under "Watching", you have selected to receive notifications by email.

For more information on how to configure notifications for secret scanning alerts, see "Configuring notifications for secret scanning alerts."

GitHub Actions notification options

For repositories that are set up with GitHub Actions and that you are watching, you can choose how you want to receive workflow run updates.

On the "Notification settings" page, select "Email" or "Web" notifications. Optionally, to only receive notifications for failed workflow runs, select "Send notifications for failed workflows only".

Organization alerts notification options

If you're an organization owner, you'll receive email notifications by default when organization members add new deploy keys to repositories within the organization. You can unsubscribe from these notifications. On the notification settings page, under "Organization alerts", deselect Email.

Managing your notification settings with GitHub Mobile

When you install GitHub Mobile, you will automatically be opted into web notifications. Within the app, you can enable push notifications for the following events.

• Direct mentions
• Assignments to issues or pull requests
• Requests to review a pull request
• Requests to approve a deployment

You can also schedule when GitHub Mobile will send push notifications to your mobile device.

GitHub Enterprise Server uses background fetch to support push notifications without sending your information to a third-party service, so you may experience a delay in receiving push notifications.

Managing your notification settings with GitHub for iOS

1. In the bottom menu, tap Profile.
2. To view your settings, tap .
3. To update your notification settings, tap Notifications and then use the toggles to enable or disable your preferred types of push notifications.
4. Optionally, to schedule when GitHub Mobile will send push notifications to your mobile device, tap Working Hours, use the Custom working hours toggle, and then choose when you would like to receive push notifications.

Managing your notification settings with GitHub for Android

1. In the bottom menu, tap Profile.
2. To view your settings, tap .
3. To update your notification settings, tap Configure Notifications and then use the toggles to enable or disable your preferred types of push notifications.
4. Optionally, to schedule when GitHub Mobile will send push notifications to your mobile device, tap Working Hours, use the Custom working hours toggle, and then choose when you would like to receive push notifications.

Configuring your watch settings for an individual repository with GitHub Mobile

You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of new releases, or completely ignore an individual repository.

1. On GitHub Mobile, navigate to the main page of the repository.
2. Tap Watch.
3. To choose what activities you receive notifications for, tap your preferred watch settings. For example, choose to only be notified when you are participating or @mentioned, or use the "Custom" option to select specific events that you want to be notified of.