Configuring notifications

Choose the type of activity on GitHub that you want to receive notifications for and how you want these updates delivered.

In this article

Notifications beta is currently released as a limited public beta feature and is not yet available to everyone. For more information, see "Enabling notifications beta."

The new notifications inbox offers an improved way to manage your notifications on GitHub and GitHub for mobile. For more information, see "Managing notifications from your inbox."

Notification delivery options

You have three basic options for notification delivery:

  • the notifications inbox on GitHub
  • the notifications inbox on GitHub for mobile, which syncs with the inbox on GitHub
  • an email client that uses a verified email address, which can also sync with the notifications inbox on GitHub and GitHub for mobile

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

Tip: If you receive both web and email notifications, you can automatically sync the read or unread status of the notification so that web notifications are automatically marked as read once you've read the corresponding email notification. To enable this sync, your email client must be able to view images from 'notifications@github.com'.

Benefits of the notifications inbox on GitHub and GitHub for mobile

The notifications inbox on GitHub and GitHub for mobile include 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.

Drop-down menu with triage options and selected notifications

In addition, the notifications inbox on GitHub for mobile allows you to triage notifications in dark mode and receive push notifications for direct mentions. For more information, see "Enabling push notifications with GitHub for mobile" or "GitHub for 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 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. To see repositories that you're watching, see https://github.com/watching. For more information, see "Managing subscriptions and notifications on GitHub."

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 on GitHub and GitHub for mobile.

Participating and watching notifications options

For example:

  • If you don't want notifications to be sent to your email, unselect email for participating and watching notifications.
  • If you want to receive notifications by email when you've participated in a conversation, then you can 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.

Tip: If you receive both web and email notifications, you can automatically sync the read or unread status of the notification so that web notifications are automatically marked as read once you've read the corresponding email notification. To enable this sync, your email client must be able to view images from 'notifications@github.com'.

If you're using Gmail, you can click a button beside the notification email to visit the original issue or pull request that generated the notification.

Buttons in Gmail

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 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 for specific repositories. For example, you can send notifications for a specific public repository to a verified personal email address. Your organization may require the email address to be verified for a specific domain.

Tips:

  • You'll only receive notification emails if you've chosen to receive email notifications in your notification settings.
  • If an organization you're a member of restricts email notifications to an approved email domain, you'll need to verify an email address in that domain to receive email notifications about activity in the organization. For more information, see "Restricting email notifications to an approved domain."

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 the following header information:

Header Information
From address This address will always be 'notifications@github.com'.
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 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 @noreply.github.com. The possible notification reasons are:
  • assign: You were assigned to an issue or pull request.
  • author: You created an issue or pull request.
  • 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 security 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.
mailing list field This field identifies the name of the repository and its owner. The format of this address is always <repository name>.<repository owner>.github.com.

Choosing your notification settings

Note: Notifications beta is currently in limited public beta and not available to everyone yet.

  1. Once you are invited to the beta, you can enable this feature under Feature preview. For more information, see "Exploring early access releases with feature preview."

    Enable notifications beta pop-up

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

    Notification indicating any unread message

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

    Manage notifications drop down menu options

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

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.

Automatic watching options

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.

Security alert options

Choose how you want to receive security alerts for repositories that you are watching. You can receive security alerts in your inbox, as a banner on GitHub, on the command line, through email, or some combination of these options.

If you want to receive security alerts by email, choose whether you want a weekly email summary of vulnerabilities for up 10 repositories or a new email each time a vulnerability is detected.

Security alerts options

GitHub Actions notification options

Choose how you want to receive workflow run updates for repositories that you are watching that are set up with GitHub Actions. You can also choose to only receive notifications for failed workflow runs.

Notification options for GitHub Actions

Enabling push notifications with GitHub for mobile

Note: GitHub for mobile is currently in limited public beta and is subject to change. We recommend that you do not rely on GitHub for mobile for high-value workflows during the beta period. For more information, see "GitHub for mobile."

When you join the GitHub for mobile limited beta you will automatically be opted into web notifications. You can then enable push notifications for direct mentions within the app.

You can only receive notifications for pushes to repositories on GitHub for mobile at this time.

Enabling push notifications with GitHub for iOS

  1. Above "Home", tap your profile photo.
  2. To view your settings, tap .
    Settings icon for GitHub for iOS
  3. To update your notification settings, tap Push notifications.
  4. To turn on push notifications for direct mentions, use the Direct Mentions toggle.

Enabling push notifications with GitHub for Android

  1. Above "Home", tap your profile photo.
  2. To view your settings, tap .
    Settings icon for GitHub for Android
  3. To turn on push notifications for direct mentions, use the Direct mentions toggle.

Ask a human

Can't find what you're looking for?

Contact us