mirror of
				https://github.com/zulip/zulip.git
				synced 2025-11-04 05:53:43 +00:00 
			
		
		
		
	integration-docs: Update Github for new doc format.
Part of zulip#29592.
This commit is contained in:
		@@ -1,25 +1,40 @@
 | 
			
		||||
# Zulip GitHub integration
 | 
			
		||||
 | 
			
		||||
Get GitHub notifications in Zulip!
 | 
			
		||||
 | 
			
		||||
{start_tabs}
 | 
			
		||||
 | 
			
		||||
1. {!create-channel.md!}
 | 
			
		||||
 | 
			
		||||
1. {!create-an-incoming-webhook.md!}
 | 
			
		||||
 | 
			
		||||
1. {!generate-integration-url.md!}
 | 
			
		||||
1. {!generate-webhook-url-basic.md!}
 | 
			
		||||
 | 
			
		||||
    You can refer to GitHub's documentation for [webhook events](https://docs.github.com/en/webhooks-and-events/webhooks/webhook-events-and-payloads).
 | 
			
		||||
1. On your repository's web page, go to **Settings**. Select **Webhooks**,
 | 
			
		||||
   and click **Add webhook**. GitHub may prompt you for your password.
 | 
			
		||||
 | 
			
		||||
    {!git-webhook-url-with-branches.md!}
 | 
			
		||||
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**.
 | 
			
		||||
 | 
			
		||||
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**.
 | 
			
		||||
{end_tabs}
 | 
			
		||||
 | 
			
		||||
{!congrats.md!}
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
See also the [GitHub Actions integration](/integrations/doc/github-actions).
 | 
			
		||||
{!event-filtering-additional-feature.md!}
 | 
			
		||||
 | 
			
		||||
### Configuration options
 | 
			
		||||
 | 
			
		||||
{!git-branches-additional-feature.md!}
 | 
			
		||||
 | 
			
		||||
### Related documentation
 | 
			
		||||
 | 
			
		||||
- [GitHub's webhook events documentation][github-webhook-events]
 | 
			
		||||
 | 
			
		||||
- [Zulip GitHub Actions integration](/integrations/doc/github-actions)
 | 
			
		||||
 | 
			
		||||
{!webhooks-url-specification.md!}
 | 
			
		||||
 | 
			
		||||
[github-webhook-events]: https://docs.github.com/en/webhooks-and-events/webhooks/webhook-events-and-payloads
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user