Webhooks

Receive a Git provider push webhook

Public endpoint that receives a push event from a Git provider (typically GitHub). The webhook token in the URL path (:webhook) authenticates the call; no Authorization header is sent.

Accepts application/json only. The optional branch query parameter filters which branch triggers a deploy — if present and body.ref does not match refs/heads/<branch>, the request is accepted with 202 but no deploy is queued. The optional restart query parameter (?restart=false) skips the post-deploy application restart.

Responses are text/plain. Rate limited to 1 push per 15 seconds per webhook token.

post/v2/git/webhook/{webhook}

Path parameters

webhookstring required

Per-application Git webhook token (64 hex chars).

Query parameters

branchstring

Lowercase branch name (≤256 chars). When provided, only matching pushes trigger a deploy.

restart'true' | 'false'

Pass false to skip the post-deploy application restart.

Request body

refstring required

refs/heads/<branch> for push events.

Response

Webhook received and the deploy job was queued.

Changes

No recorded changes to this endpoint across all 1 revision of this API.