Integrations

Purpose — Notploy is meant to fit into your existing pipeline, not replace it. This page covers the two ways deployments are triggered from outside the dashboard and how to wire them up.

Git providers

Connect providers so Notploy can read repositories and receive push webhooks:

A provider connection gives you repository access, branch selection and auto-deploy on push. See Auto-deploy and Watch paths to control when a push triggers a deployment.

For repositories outside a supported provider, use an SSH key and any Git URL.

CI/CD workflows

There are two integration patterns:

1. Push-to-deploy (webhook)

Notploy exposes a webhook per service. When the provider notifies Notploy of a push, Notploy deploys. This keeps the pipeline out of the loop entirely:

git push ──► Git provider ──► webhook ──► Notploy deploy

Best when your build is fully described by the build type and you do not need CI steps beyond building.

2. Deploy-from-CI (API call)

When you need CI steps — tests, migrations, extra checks — run them in your pipeline and trigger the deployment at the end by calling the API or CLI:

# after your tests pass
curl -X POST 'https://your-panel.example.com/api/application.deploy' \
  -H 'x-api-key: '"$NOTPLOY_API_KEY" \
  -H 'content-type: application/json' \
  -d '{"applicationId":"'"$APP_ID"'"}'

Store NOTPLOY_API_KEY in your CI secret store. See API keys.

On GitHub Actions, use the official GitHub Actions action instead of hand-writing the call: it triggers the deployment, waits for the result and fails the job when the deployment fails.

Preview environments

To build a preview per pull request, create a preview deployment and expose it on a generated or wildcard domain.

Automation patterns

Goal	Approach
Deploy on every push to `main`	Provider webhook + auto-deploy.
Deploy only when `apps/api` changes	Provider webhook + watch paths.
Run tests before deploying	CI job + API/CLI deploy call, or the official GitHub Actions action.
Preview per pull request	Preview deployments.
Sync infrastructure state	SDK reconciliation script.