Show More
@@ -1,22 +1,24 b'' | |||||
1 | .. _integrations-webhook: |
|
1 | .. _integrations-webhook: | |
2 |
|
2 | |||
3 | Webhook integration |
|
3 | Webhook integration | |
4 | =================== |
|
4 | =================== | |
5 |
|
5 | |||
6 |
The |
|
6 | The :ref:`creating-integrations` integration allows you to POST events such as | |
7 |
or pull requests to a custom http endpoint as a |
|
7 | repository pushes or pull requests to a custom http endpoint as a JSON dict | |
8 | event. |
|
8 | with details of the event. | |
9 |
|
9 | |||
10 | Starting from 4.5.0 release, webhook integration allows to use variables |
|
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}` |
|
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 |
|
12 | ${repo_name} will be replaced with the name of repository which events is | |
13 | triggered from. Some of the variables like |
|
13 | triggered from. Some of the variables like | |
14 | `${branch}` will result in webhook be called multiple times when multiple |
|
14 | `${branch}` will result in webhook be called multiple times when multiple | |
15 | branches are pushed. |
|
15 | branches are pushed. | |
16 |
|
16 | |||
17 | Some of the variables like `${pull_request_id}` will be replaced only in |
|
17 | Starting from 4.8.0 also repository extra fields can be used. A format to use | |
18 | the pull request related events. |
|
18 | them is `${extra:field_key}`. It's usefull to use them to specify custom | |
|
19 | repo only parameters. Some of the variables like `${pull_request_id}` | |||
|
20 | will be replaced only in the pull request related events. | |||
19 |
|
21 | |||
20 | To create a webhook integration, select "webhook" in the integration settings |
|
22 | To create a webhook integration, select "webhook" in the integration settings | |
21 | and use the URL and key from your any previous custom webhook created. See |
|
23 | and use the URL and key from your any previous custom webhook created. See | |
22 | :ref:`creating-integrations` for additional instructions. |
|
24 | :ref:`creating-integrations` for additional instructions. |
General Comments 0
You need to be logged in to leave comments.
Login now