engineering/unrhodecode
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: add note about variables in webhooks.

Browse source
This commit is contained in:
Marcin Kuzminski 2016-10-05 21:27:16 +02:00
parent 39879f0dff
commit 9d51d1bb4a
1 changed files with 12 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/integrations/webhook.rst
View file

@ -7,6 +7,16 @@ 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.
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.
To create a webhook integration, select "webhook" in the integration settings
and use the url and key from your custom webhook. See
:ref:`creating-integrations` for additional instructions.
and use the URL and key from your any previous custom webhook created. See
:ref:`creating-integrations` for additional instructions.