Overview
Connect a GitHub repository to a Canvas app and every push to your branch triggers an automatic build and deploy. Pull requests get preview URLs for live review before merging.
Connecting a repo
curl -X POST https://api.mixpeek.com/v1/apps/$APP_ID/connect-repo \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"repo_url": "https://github.com/your-org/your-repo",
"branch": "main"
}'
push and pull_request events on the specified branch.
Automatic deploys on push
When you push to the connected branch:
- GitHub sends a
push webhook to Canvas
- Canvas clones your repo and checks out the pushed commit
- Runs
npm ci to install dependencies
- Runs
npm run build to produce the build output
- Zips the
dist/ directory and deploys it
Build output is streamed in real time — see Build Logs.
Canvas auto-detects your build output directory. It looks for dist/, build/, or out/ in order.
What gets built
Canvas runs a standard Node.js build process:
git clone <repo_url> --branch <branch> --depth 1
cd <repo>
npm ci
npm run build
package.json must include a build script. The build output must contain an index.html.
Every deploy from GitHub automatically records git metadata in the version record:
| Field | Description |
|---|
git_commit_sha | The commit SHA that triggered the deploy |
git_author | Author of the commit |
git_branch | Branch name |
Webhook events
| Event | Canvas behavior |
|---|
push to connected branch | Build and deploy to production |
pull_request opened/updated | Build and deploy preview |
pull_request closed | Clean up preview environment |
Disconnecting
To stop automatic deploys, remove the webhook from your GitHub repository settings or update the app’s configuration to remove the repo_url.
