Deployments

Configure or remove the Git deploy webhook

Changed on Nov 13, 2026

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

Request

Base URL
https://api.squarecloud.app
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/squarecloud/apis/square-cloud-api/docs/v2/apps/:appId/deploy/webhook/post.ts
A function with typed inputs. Its response is checked against the schema.

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

Nov 13, 2026e363e004303c Revision changes
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
Nov 2, 20264cf53a0d5577 Revision changes
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status

Operation history (8 revisions)