mirror of
				https://github.com/zulip/zulip.git
				synced 2025-11-04 05:53:43 +00:00 
			
		
		
		
	webhooks/beanstalk: Update text and remove screenshots.
This commit: * Removes the unnecessary screenshot. * Reorders the instructions and combines them in to 4 steps. * Improves the contents of the webhook-url-with-bot-email-indented.md macro and makes it more consistent with create-bot-construct-url.md. * Sets the recommended stream name to "commits", since that's what the webhook function for Beanstalk expects in zerver/webhooks/beanstalk/view.py. This allows us to use the create-stream.md macro.
This commit is contained in:
		
										
											Binary file not shown.
										
									
								
							| 
		 Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 20 KiB  | 
										
											Binary file not shown.
										
									
								
							| 
		 Before Width: | Height: | Size: 20 KiB  | 
@@ -1,7 +1,9 @@
 | 
			
		||||
    In the URL field, enter:
 | 
			
		||||
    Construct the URL for the {{ integration_display_name }}
 | 
			
		||||
    bot using the bot's API key and email address:
 | 
			
		||||
 | 
			
		||||
    `{{ external_uri_scheme }}bot_email:bot_api_key@{{ api_url_scheme_relative }}{{ integration_url }}`
 | 
			
		||||
 | 
			
		||||
    Replace `bot_email` and `bot_api_key` above with the URL-encoded email
 | 
			
		||||
    address and API key of the bot.  To URL-encode the email address, you
 | 
			
		||||
    just need to replace `@` in the bot's email address with `%40`.
 | 
			
		||||
    Modify the parameters of the URL above, where `bot_email` is
 | 
			
		||||
    the bot's URL-encoded email address and `bot_api_key` is the
 | 
			
		||||
    bot's API key.  To URL-encode the email address, you just need
 | 
			
		||||
    to replace `@` in the bot's email address with `%40`.
 | 
			
		||||
 
 | 
			
		||||
@@ -263,7 +263,7 @@ EMBEDDED_BOTS = [
 | 
			
		||||
WEBHOOK_INTEGRATIONS = [
 | 
			
		||||
    WebhookIntegration('airbrake', ['monitoring']),
 | 
			
		||||
    WebhookIntegration('appfollow', ['customer-support'], display_name='AppFollow'),
 | 
			
		||||
    WebhookIntegration('beanstalk', ['version-control']),
 | 
			
		||||
    WebhookIntegration('beanstalk', ['version-control'], stream_name='commits'),
 | 
			
		||||
    WebhookIntegration('basecamp', ['project-management']),
 | 
			
		||||
    WebhookIntegration('beeminder', ['misc'], display_name='Beeminder'),
 | 
			
		||||
    WebhookIntegration(
 | 
			
		||||
 
 | 
			
		||||
@@ -1,19 +1,21 @@
 | 
			
		||||
Zulip supports both SVN and Git notifications from Beanstalk.
 | 
			
		||||
 | 
			
		||||
1. First, create the stream `commits` and subscribe all
 | 
			
		||||
   interested parties to this stream.
 | 
			
		||||
1. {!create-stream.md!}
 | 
			
		||||
 | 
			
		||||
2. Next, in the Beanstalk web application, go to the **Setup** page
 | 
			
		||||
   and choose the **Integrations** tab.
 | 
			
		||||
1. {!create-a-bot-indented.md!}
 | 
			
		||||
 | 
			
		||||
3. Choose the **Webhooks** integration from the list presented.
 | 
			
		||||
   {!webhook-url-with-bot-email-indented.md!}
 | 
			
		||||
   {!git-append-branches.md!}
 | 
			
		||||
 | 
			
		||||
4. {!webhook-url-with-bot-email-indented.md!}
 | 
			
		||||
1. Next, on your repository's webpage, click on the **Settings**
 | 
			
		||||
   tab. Click on the **Integrations** tab, scroll down and click on
 | 
			
		||||
   **Modular Webhooks**. Click on the **Add a webhook** button.
 | 
			
		||||
 | 
			
		||||
5. {!git-append-branches.md!}
 | 
			
		||||
 | 
			
		||||
    
 | 
			
		||||
1. Set **Name** to a name of your choice, such as `Zulip`.
 | 
			
		||||
   Set **URL** to the URL you created above. Under
 | 
			
		||||
   **Select webhook triggers**, check the events that you would
 | 
			
		||||
   like to receive notifications for, and click **Activate**.
 | 
			
		||||
 | 
			
		||||
{!congrats.md!}
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||

 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user