Files
zulip/zerver/webhooks/github/doc.md
Zixuan James Li 234771d5db integrations: Add a link to GitHub webhooks documentation.
The list of supported events for filtering itself does not document what
each of the events does. Adding a link to GitHub's documentation would
be a pointer to get people started. But ideally we need to establish a
better system to document the events in general.

Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2023-03-15 15:37:42 -07:00

24 lines
793 B
Markdown

Get GitHub notifications in Zulip!
1. {!create-stream.md!}
1. {!create-bot-construct-url.md!}
You can refer to GitHub's documentation for [webhook events](https://docs.github.com/en/webhooks-and-events/webhooks/webhook-events-and-payloads).
{!git-webhook-url-with-branches.md!}
1. Go to your repository on GitHub and click on the **Settings** tab.
Select **Webhooks**. Click on **Add webhook**. GitHub may prompt
you for your password.
1. Set **Payload URL** to the URL constructed above. Set **Content type**
to `application/json`. Select the events you would like to receive
notifications for, and click **Add Webhook**.
{!congrats.md!}
![](/static/images/integrations/github/001.png)
See also the [GitHub Actions integration](/integrations/doc/github-actions).