Files
upstream-zulip/zerver/webhooks/github/doc.md
upstream-mirror 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
snapshot of https://github.com/zulip/zulip.git @ 48c69911c7dd4e03b20552eb3bd77ad8151c1357 (2026-09-15)
2026-09-15 15:05:30 +05:00

1.6 KiB

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!}

{!webhooks-url-specification.md!}