Zulip GitHub integration

Get GitHub notifications in Zulip!

!!! tip ""

If you also configure a [custom profile
field](/help/custom-profile-fields) for GitHub accounts, this
integration will refer to GitHub users using [Zulip silent
mentions](/help/mention-a-user-or-group#silently-mention-a-user),
rather than their GitHub username.

{start_tabs}

1. {!create-an-incoming-webhook.md!}

2. Decide where to send {{ integration_display_name }} notifications, and generate the integration URL. You'll be able to configure:

   • Which branches you'll receive notifications from.
   • Whether to exclude notifications from private repositories.
   • Whether to include the repository name in the notifications.
   • Whether to include emoji indicators in the notifications.

3. On your repository's web page, go to Settings. Select Webhooks, and click Add webhook. GitHub may prompt you for your password.

4. Set Payload URL to the URL generated above. Set Content type to application/json. Select the events you'd like to be notified about, and click Add Webhook.

{end_tabs}

{!congrats.md!}

{!event-filtering-additional-feature.md!}

Related documentation

• GitHub's webhook events documentation

• Zulip GitHub Actions integration

{!webhooks-url-specification.md!}