rhodecode-enterprise-ce Files · docs/integrations/webhook.rst

docs: add note about variables in webhooks.

marcink - - Load All Authors

File last commit:

r939:678c8b0e default


                r939:678c8b0e

default

Download file

             webhook.rst
        
                    22 lines
            
             | 911 B
            
                | text/x-rst
            
             |
                RstLexer
            
             / docs / integrations / webhook.rst
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        dan
    
docs: updated docs for integrations, fixes #4137...

              r552
            
      .. _integrations-webhook:

      Webhook integration

      ===================

      The Webhook integration allows you to POST events such as repository pushes

      or pull requests to a custom http endpoint as a json dict with details of the

      event.

        marcink
    
docs: add note about variables in webhooks.

              r939
            
      Starting from 4.5.0 release, webhook integration allows to use variables

      inside the URL. For example in URL `https://server-example.com/${repo_name}`

      ${repo_name} will be replaced with the name of repository which events is

      triggered from. Some of the variables like

      `${branch}` will result in webhook be called multiple times when multiple

      branches are pushed.

      Some of the variables like `${pull_request_id}` will be replaced only in

      the pull request related events.

        lisaq
    
docs: updated integrations docs fix #4137

              r645
            
      To create a webhook integration, select "webhook" in the integration settings

        marcink
    
docs: add note about variables in webhooks.

              r939
            
      and use the URL and key from your any previous custom webhook created. See

      :ref:`creating-integrations` for additional instructions.

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

dan docs: updated docs for integrations, fixes #4137...	r552	.. _integrations-webhook:

		Webhook integration
		===================

		The Webhook integration allows you to POST events such as repository pushes
		or pull requests to a custom http endpoint as a json dict with details of the
		event.

marcink docs: add note about variables in webhooks.	r939	Starting from 4.5.0 release, webhook integration allows to use variables
		inside the URL. For example in URL `https://server-example.com/${repo_name}`
		${repo_name} will be replaced with the name of repository which events is
		triggered from. Some of the variables like
		`${branch}` will result in webhook be called multiple times when multiple
		branches are pushed.

		Some of the variables like `${pull_request_id}` will be replaced only in
		the pull request related events.

lisaq docs: updated integrations docs fix #4137	r645	To create a webhook integration, select "webhook" in the integration settings
marcink docs: add note about variables in webhooks.	r939	and use the URL and key from your any previous custom webhook created. See
		:ref:`creating-integrations` for additional instructions.