How to set up automatic deployments

DeployHQ supports automatic deployments from a number of repository hosting services, meaning you can run a deployment when code is pushed to your repository without logging into DeployHQ to start it. The currently supported repository hosts are:

You can even start an automatic deployment from your own custom service, by sending a simple JSON payload to your server's webhook endpoint.

Each project has a unique automatic deployment URL, this is a URL that you can add to your repository as a webhook, so DeployHQ is notified when new commits are pushed to your repository. Once you've added the webhook, you can configure individual servers for automatic deployment as required.

Getting the webhook URL for a project

Firstly navigate to the Automatic Deployments page on the left hand side in your project, then copy the URL in the middle of the page.

Enable auto deployments

Just below, you'll see a list of servers and groups in the project, with a toggle on the right hand side to enable automatic deployments on an individual basis.

Specifying a branch to deploy from

The automatic deployment process will check the branch configured for your server (the Branch to deploy from) each time a request is posted to the webhook URL. If the branch is found to match, the deployment will be queued, otherwise it will be ignored. If you wish to change the branch, just navigate to your server settings in DeployHQ, then update the Branch to Deploy from found under Deployment Options.

Advanced server configuration

Proudly powered by Katapult. Running on 100% renewable energy.