Configure Webhooks

Webhooks allow the PullRequest application to be more responsive.

Once the PullRequest Proxy service is running, it will start a webserver for fielding webhooks from the provider. For these, it's listening on port 5012 if not using SSL and on port 8443 if SSL is configured.

It's often useful to configure a DNS entry with a simple A record pointing at the IP address of this instance so that webhooks can be configured properly.

Below are links to configure webhooks for each of the providers. Go ahead and pick the provider you're using and follow the instructions. In order to configure a webhook secret to validate webhooks signed by the provider, the PROVIDER_WEBHOOK_SECRET field must be configured in the .env file that we edited earlier.

su pullrequest
cd $HOME/pullrequest_proxy
vim .env

Add any string to the following line:

PROVIDER_WEBHOOK_SECRET=<webhook_secret>

When configuring the PROVIDER_WEBHOOK_SECRET field for Azure DevOps, you actually need to configure two values - a username and a password. These should be formatted as such in this field: <username>:<password>

When you're finished editing the file, go ahead and exit the pullrequest user's shell and restart the service to pull in the new configuration.

exit
systemctl restart pullrequest-proxy

This field is optional. And if it's configured, this secret must be used when configuring webhooks for your provider or else it won't function properly.

Configure GitHub WebhooksConfigure GitLab WebhooksConfigure Bitbucket WebhooksConfigure Azure DevOps Webhooks