Deployments

Configure or remove the Git deploy webhook

Configures the application to deploy on push from a Git provider. Passing access_token: "@" removes the webhook; passing a GitHub personal access token (ghp_* / github_pat_*) enrolls the application and returns its webhook URL.

Requires the workspace Administrator role (or ownership) when called against a workspace-shared application. Rate limited to 5 calls per 60s per user.

post/v2/apps/{appId}/deploy/webhook

Path parameters

appIdstring required

Application identifier. Optionally suffixed with -<workspaceId> to act on a workspace-shared application.

Request body

access_tokenstring required

GitHub personal access token (ghp_* / github_pat_*), or @ to remove the existing webhook.

Response

Webhook configured (with response.webhook) or removed.

status'success' required

Changes

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