##// END OF EJS Templates
docs: add note about variables in webhooks.
marcink -
r939:678c8b0e default
parent child Browse files
Show More
@@ -1,12 +1,22 b''
1 .. _integrations-webhook:
1 .. _integrations-webhook:
2
2
3 Webhook integration
3 Webhook integration
4 ===================
4 ===================
5
5
6 The Webhook integration allows you to POST events such as repository pushes
6 The Webhook integration allows you to POST events such as repository pushes
7 or pull requests to a custom http endpoint as a json dict with details of the
7 or pull requests to a custom http endpoint as a json dict with details of the
8 event.
8 event.
9
9
10 Starting from 4.5.0 release, webhook integration allows to use variables
11 inside the URL. For example in URL `https://server-example.com/${repo_name}`
12 ${repo_name} will be replaced with the name of repository which events is
13 triggered from. Some of the variables like
14 `${branch}` will result in webhook be called multiple times when multiple
15 branches are pushed.
16
17 Some of the variables like `${pull_request_id}` will be replaced only in
18 the pull request related events.
19
10 To create a webhook integration, select "webhook" in the integration settings
20 To create a webhook integration, select "webhook" in the integration settings
11 and use the url and key from your custom webhook. See
21 and use the URL and key from your any previous custom webhook created. See
12 :ref:`creating-integrations` for additional instructions. No newline at end of file
22 :ref:`creating-integrations` for additional instructions.
General Comments 0
You need to be logged in to leave comments. Login now