mirror of
https://github.com/zulip/zulip.git
synced 2025-11-07 15:33:30 +00:00
eb55a3a1ba
The "subdomain" label is redundant, to the extent it's even accurate -- this is really just the URL we want to display, which may or may not involve a subdomain. Similarly "external". The former `external_api_path_subdomain` was never a path -- it's a host, followed by a path, which together form a scheme-relative URL. I'm not quite convinced that value is actually the right thing in 2 of the 3 places we use it, but fixing that can start by giving an accurate name to the thing we have.
45 lines
1.6 KiB
Markdown
45 lines
1.6 KiB
Markdown
This webhook is based on the deprecated
|
|
[GitHub Services](https://github.com/github/github-services).
|
|
|
|
{!create-stream.md!}
|
|
|
|
The integration will use the default stream `commits`
|
|
if no stream is supplied in the hook; you still need to create
|
|
the stream even if you are using this default.
|
|
|
|
Next, go to your repository page and click **Settings**:
|
|
|
|
|
|
|
|
From there, select **Webhooks & Services**:
|
|
|
|
|
|
|
|
To find the Zulip hook, you have to click on **Configure services**.
|
|
|
|
|
|
|
|
Select **Zulip** from the list of service hooks. Fill in the API key
|
|
and email address for your bot that you created earlier and check
|
|
the **"active"** checkbox. Specify
|
|
`{{ api_url }}/v1/external/github` as the
|
|
**Alternative endpoint**. You can optionally supply the Zulip stream
|
|
(the default is `commits`) and restrict Zulip notifications to a
|
|
specified set of branches.
|
|
|
|
Further configuration is possible. By default, commits traffic
|
|
(pushes, commit comments), GitHub issues traffic, and pull requests
|
|
are enabled. You can exclude certain types of traffic via the checkboxes.
|
|
If you want commit traffic, issue traffic, and pull requests to go to
|
|
different places, you can use the **Commit Stream** and **Issue Stream**
|
|
overrides; otherwise, it is safe to leave these fields blank and just
|
|
have it default to the **Stream** setting.
|
|
|
|
Click the **Update settings** button to complete the configuration:
|
|
|
|
|
|
|
|
{!congrats.md!}
|
|
|
|
|