Auto-Deploy

Auto-deploy automatically triggers a new deployment whenever you push commits to the configured branch. This enables a continuous deployment workflow — push your code, and Convoy Cloud handles the rest.

Enabling auto-deploy

Toggle Auto-Deploy in the Build Configuration step when creating or updating a deployment.

When enabled:

1. Convoy Cloud monitors the configured branch for new commits via the GitHub App webhook.
2. When a new commit is pushed, a new deployment is triggered automatically.
3. The new deployment uses the same configuration (build method, resources, env vars, port) as the original, but builds from the latest commit.
4. The previous deployment is superseded by the new one — traffic shifts to the new deployment once it is healthy.

How it works

Auto-deploy uses the GitHub App's webhook integration:

git push origin main
    ↓
GitHub webhook → Convoy Cloud API
    ↓
New deployment triggered
    ↓
Build → Deploy → Live

Requirements

• The GitHub App must be installed and authorized for the repository
• The repository must be granted to the workspace
• Auto-deploy must be toggled on for the specific deployment

Deployment strategy

When auto-deploy triggers a new deployment:

• The new version is built and deployed alongside the existing one
• Once the new version passes health checks, traffic is routed to it
• The old deployment is marked as superseded

Disabling auto-deploy

To stop automatic deployments, create a new deployment with the Auto-Deploy toggle turned off. You can still deploy manually at any time from the dashboard.

Under the hood Auto-deploy is triggered by a GitHub App webhook that fires on push events to the configured branch.