# HG changeset patch # User Marcin Kuzminski # Date 2016-10-05 19:27:16 # Node ID 678c8b0e7edf0797b3c79f0aa805ad2c883573fb # Parent 87d3b112c6f265e4d09b5273f9ffbf3df2333d35 docs: add note about variables in webhooks. diff --git a/docs/integrations/webhook.rst b/docs/integrations/webhook.rst --- a/docs/integrations/webhook.rst +++ b/docs/integrations/webhook.rst @@ -7,6 +7,16 @@ The Webhook integration allows you to PO 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. \ No newline at end of file +and use the URL and key from your any previous custom webhook created. See +:ref:`creating-integrations` for additional instructions.