64898b2c79
Some checks failed
Code scanning / CodeQL (push) Failing after 15s
Zulip production suite / Ubuntu 22.04 production build (push) Failing after 26s
Zulip production suite / Debian 12 production install with custom db name and user (push) Has been skipped
Zulip production suite / Ubuntu 22.04 production install and PostgreSQL upgrade with pgroonga (push) Has been skipped
Zulip production suite / Ubuntu 24.04 production install (push) Has been skipped
Zulip production suite / Ubuntu 26.04 production install (push) Has been skipped
Zulip production suite / Debian 13 production install (push) Has been skipped
Zulip production suite / 7.0 Version Upgrade (push) Has been skipped
Zulip production suite / 8.0 Version Upgrade (push) Has been skipped
Zulip production suite / 6.0 Version Upgrade (push) Has been skipped
Zulip production suite / 10.0 Version Upgrade (push) Has been skipped
Zulip production suite / 9.0 Version Upgrade (push) Has been skipped
Zulip production suite / 12.0 Version Upgrade (push) Has been skipped
Zulip production suite / 11.0 Version Upgrade (push) Has been skipped
GitHub Actions Security Analysis with zizmor / zizmor (push) Failing after 3s
Zulip CI / Debian 12 (Python 3.11, backend + documentation) (push) Failing after 26s
Zulip CI / Ubuntu 22.04 (Python 3.10, backend + frontend) (push) Failing after 3s
Zulip CI / Ubuntu 24.04 (Python 3.12, backend) (push) Failing after 25s
Zulip CI / Ubuntu 26.04 (Python 3.14, backend) (push) Failing after 25s
Zulip CI / Debian 13 (Python 3.13, backend) (push) Failing after 28s
Zulip production suite / Required jobs (push) Has been cancelled
Zulip CI / Required jobs (push) Has been cancelled
API Documentation Update Check / check-feature-level-updated (push) Has been cancelled
API Documentation Update Check / notify-if-api-docs-changed (push) Has been cancelled
50 lines
1.6 KiB
Markdown
50 lines
1.6 KiB
Markdown
# 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!}
|
|
|
|
1. Decide where to send {{ integration_display_name }} notifications, and
|
|
[generate the integration URL](/help/generate-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.
|
|
|
|
|
|
1. On your repository's web page, go to **Settings**. Select **Webhooks**,
|
|
and click **Add webhook**. GitHub may prompt you for your password.
|
|
|
|
1. Set **Payload URL** to the URL generated above. Set **Content type**
|
|
to `application/json`. Select the [events](#filtering-incoming-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][github-webhook-events]
|
|
|
|
- [Zulip GitHub Actions integration](/integrations/github-actions)
|
|
|
|
{!webhooks-url-specification.md!}
|
|
|
|
[github-webhook-events]: https://docs.github.com/en/webhooks-and-events/webhooks/webhook-events-and-payloads
|