--- title: list-user-events product: vercel url: /docs/rest-api/user/list-user-events type: reference prerequisites: [] related: - /docs/rest-api summary: Learn about list-user-events on Vercel. install_vercel_plugin: npx plugins add vercel/vercel-plugin --- # List User Events ```http GET /v3/events ``` Retrieves a list of "events" generated by the User on Vercel. Events are generated when the User performs a particular action, such as logging in, creating a deployment, and joining a Team (just to name a few). When the `teamId` parameter is supplied, then the events that are returned will be in relation to the Team that was specified. ## Authentication **bearerToken**: HTTP bearer ## Query parameters | Name | Type | Required | Description | |---|---|---|---| | `limit` | number | No | Maximum number of items which may be returned. | | `since` | string | No | Timestamp to only include items created since then. | | `until` | string | No | Timestamp to only include items created until then. | | `types` | string | No | Comma-delimited list of event \"types\" to filter the results by. | | `userId` | string | No | Deprecated. Use `principalId` instead. If `principalId` and `userId` both exist, `principalId` will be used. | | `principalId` | string | No | When retrieving events for a Team, the `principalId` parameter may be specified to filter events generated by a specific principal. | | `projectIds` | string | No | Comma-delimited list of project IDs to filter the results by. | | `withPayload` | string | No | When set to `true`, the response will include the `payload` field for each event. | | `teamId` | string | No | The Team identifier to perform the request on behalf of. | | `slug` | string | No | The Team slug to perform the request on behalf of. | ## Responses ### 200: Successful response. Content-Type: `application/json` ```json { "oneOf": [ { "type": "object" }, { "type": "object", "description": "Successful response.", "required": [ "events" ], "properties": { "events": { "type": "array", "description": "Array of events generated by the User.", "items": { "type": "object", "description": "Array of events generated by the User.", "required": [ "createdAt", "entities", "id", "principalId", "text", "userId" ], "properties": { "id": { "type": "string", "description": "The unique identifier of the Event." }, "text": { "type": "string", "description": "The human-readable text of the Event." }, "entities": { "type": "array", "description": "A list of \"entities\" within the event `text`. Useful for enhancing the displayed text with additional styling and links.", "items": { "type": "object", "description": "A list of \"entities\" within the event `text`. Useful for enhancing the displayed text with additional styling and links.", "required": [ "end", "start", "type" ], "properties": { "type": { "type": "string", "description": "The type of entity.", "enum": [ "app", "author", "bitbucket_login", "bold", "deployment_host", "dns_record", "git_link", "github_login", "gitlab_login", "hook_name", "integration", "edge-config", "flag", "flags-segment", "flags-settings", "link", "project_name", "scaling_rules", "env_var_name", "target", "store", "system" ] }, "start": { "type": "number", "description": "The index of where the entity begins within the `text` (inclusive)." }, "end": { "type": "number", "description": "The index of where the entity ends within the `text` (non-inclusive)." } } } }, "type": { "type": "string", "description": "The type of the event.", "enum": [ "team", "avatar", "alias", "plan", "flag", "deployment", "access-group-created", "access-group-deleted", "access-group-project-updated", "access-group-updated", "access-group-user-added", "access-group-user-removed", "password-protection-disabled", "password-protection-enabled", "aliases-assigned", "alias-chown", "alias-delete", "alias-invite-created", "alias-invite-joined", "alias-invite-revoked", "alias-protection-bypass-created", "alias-protection-bypass-exception", "alias-protection-bypass-regenerated", "alias-protection-bypass-revoked", "alias-system", "alias-user-scoped-access-denied", "alias-user-scoped-access-granted", "alias-user-scoped-access-requested", "alias-user-scoped-access-revoked", "oauth-app-connection-created", "oauth-app-connection-removed", "oauth-app-connection-updated", "oauth-app-created", "oauth-app-deleted", "vercel-app-installation-request-dismissed", "vercel-app-installation-requested", "vercel-app-installation-updated", "vercel-app-installed", "oauth-app-secret-deleted", "oauth-app-secret-generated", "oauth-app-token-created", "vercel-app-tokens-revoked", "vercel-app-uninstalled", "oauth-app-updated", "attack-mode-disabled", "attack-mode-enabled", "auto-expose-system-envs", "invoice-refunded", "invoice-modified", "payment-method-added", "payment-method-default-updated", "payment-method-removed", "subscription-created", "subscription-updated", "subscription-product-added", "subscription-product-removed", "bulk-redirects-settings-updated", "bulk-redirects-version-promoted", "bulk-redirects-version-restored", "cert", "cert-system-create", "cert-autorenew", "cert-chown", "cert-clone", "cert-delete", "cert-renew", "cert-replace", "connect-configuration-created", "connect-configuration-deleted", "connect-configuration-link-updated", "connect-configuration-linked", "connect-configuration-unlinked", "connect-configuration-updated", "connect-github", "disconnect-github", "connect-github-limited", "disconnect-github-limited", "connect-github-custom-host", "disconnect-github-custom-host", "connect-gitlab", "connect-gitlab-app", "disconnect-gitlab-app", "connect-bitbucket", "connect-bitbucket-app", "disconnect-bitbucket-app", "custom-suffix-clear", "custom-suffix-disable", "preview-deployment-suffix-disabled", "custom-suffix-enable", "preview-deployment-suffix-enabled", "custom-suffix-pending", "custom-suffix-ready", "deploy-hook-created", "deploy-hook-deleted", "deploy-hook-deduped", "deploy-hook-processed", "deployment-check-created", "deployment-check-updated", "deployment-check-deleted", "authorize-git-deployment", "deployment-chown", "deployment-creation-blocked", "deployment-delete", "disabled-integration-installation-removed", "dns-add", "dns-delete", "dns-update", "domain", "domain-buy", "domain-cdn", "domain-chown", "domain-delegated", "domain-delete", "domain-service-type-updated", "domain-custom-ns-change", "dns-zonefile-import", "domain-zone-change", "domain-move-in", "domain-move-out", "domain-move-out-request-sent", "domain-renew-change", "domain-transfer-in", "domain-transfer-in-canceled", "domain-transfer-in-completed", "drain-created", "drain-deleted", "drain-disabled", "drain-enabled", "drain-updated", "edge-cache-dangerously-delete-by-src-images", "edge-cache-dangerously-delete-by-tags", "edge-cache-invalidate-by-src-images", "edge-cache-invalidate-by-tags", "edge-cache-purge-all", "edge-cache-rollback-purge", "edge-config-created", "edge-config-deleted", "edge-config-items-updated", "edge-config-schema-deleted", "edge-config-schema-updated", "edge-config-transfer-in", "edge-config-transfer-out", "edge-config-token-created", "edge-config-token-deleted", "edge-config-updated", "email", "email-notification-rule-removed", "email-notification-rule-updated", "env-variable-add", "env-variable-delete", "env-variable-edit", "env-variable-read", "env-variable-read:cli:dev", "env-variable-read:cli:env:add", "env-variable-read:cli:env:ls", "env-variable-read:cli:env:pull", "env-variable-read:cli:env:rm", "env-variable-read:cli:pull", "env-variable-read:unknown-source", "env-variable-read:v0:env:pull", "shared-env-variable-create", "shared-env-variable-delete", "shared-env-variable-read", "shared-env-variable-update", "firewall-bypass-created", "firewall-bypass-deleted", "firewall-config-modified", "firewall-config-promoted", "firewall-config-removed", "firewall-managed-rulegroup-updated", "firewall-managed-ruleset-updated", "flags-segment", "flags-settings", "flags-explorer-subscription", "flags-sdk-key", "instant-rollback-created", "integration-configuration-owner-changed", "integration-configuration-scope-change-confirmed", "integration-configurations-disabled", "integration-installation-billing-plan-updated", "integration-installation-completed", "integration-installation-permission-updated", "integration-installation-removed", "integration-scope-changed", "log-drain-created", "log-drain-deleted", "log-drain-disabled", "log-drain-enabled", "login", "manual-deployment-promotion-created", "microfrontend-group-added", "microfrontend-group-deleted", "microfrontend-group-updated", "microfrontend-project-added-to-group", "microfrontend-project-removed-from-group", "microfrontend-project-updated", "monitoring-disabled", "monitoring-enabled", "observability-disabled", "observability-enabled", "observability-plus-project-disabled", "observability-plus-project-enabled", "owner-blocked", "owner-unblocked", "owner-soft-blocked", "owner-soft-unblocked", "passkey-created", "passkey-deleted", "passkey-updated", "preview-deployment-suffix-update", "privatelink-endpoint-created", "production-branch-updated", "project-directory-listing", "project-analytics-disabled", "project-speed-insights-disabled", "project-analytics-enabled", "project-speed-insights-enabled", "project-automation-bypass", "project-affected-projects-deployments-updated", "project-external-rewrite-caching-updated", "project-build-command-updated", "project-framework-updated", "project-install-command-updated", "project-node-version-updated", "project-output-directory-updated", "project-prioritize-production-builds-updated", "project-root-directory-updated", "project-source-files-outside-root-directory-updated", "project-build-machine-updated", "project-client-cert-delete", "project-client-cert-upload", "project-connect-configurations", "project-created", "project-cron-jobs-toggled", "project-delete", "project-domain-unverified", "project-domain-verified", "project-elastic-concurrency-updated", "project-auto-assign-custom-production-domains-updated", "project-preview-environment-branch-tracking-updated", "project-custom-environment-updated", "project-custom-environment-created", "project-custom-environment-deleted", "project-functions-fluid-disabled", "project-functions-fluid-enabled", "project-function-max-duration", "project-function-cpu-memory", "project-function-regions", "project-function-failover", "project-preview-deployment-suffix", "project-name", "project-git-repository-connected", "project-git-repository-disconnected", "project-git-pr-comments-toggled", "project-git-commit-comments-toggled", "project-git-repository-dispatch-events-toggled", "project-git-create-deployments-toggled", "project-git-require-verified-commits-toggled", "project-git-lfs-toggled", "project-consolidated-git-commit-status-updated", "project-ignored-build-step-updated", "project-add-alias", "project-add-redirect", "project-domain-deleted", "project-domain-moved", "project-domain-updated", "project-member-removed-batch", "project-alias-configured-change", "project-member-added", "project-member-invited", "project-member-removed", "project-member-updated", "project-move-in-success", "project-move-out-failed", "project-move-out-started", "project-move-out-success", "project-oidc-token-created", "project-options-allowlist", "project-password-protection", "project-paused", "project-program-enrollment-changed", "project-rolling-release-enabled", "project-rolling-release-disabled", "project-rolling-release-configured", "project-rolling-release-started", "project-rolling-release-completed", "project-rolling-release-aborted", "project-rolling-release-approved", "project-rolling-release-timer", "project-routes-version-promoted", "project-routes-version-restored", "project-oidc-issuer-mode-updated", "project-customer-success-code-visibility-updated", "project-git-fork-protection-updated", "project-protected-sourcemaps-updated", "project-build-logs-and-source-protection-updated", "project-deployment-retention-updated", "project-skew-protection-threshold-updated", "project-skew-protection-max-age-updated", "project-skew-protection-allowed-domains-updated", "project-sso-protection", "project-static-ips-updated", "project-trusted-ips", "project-unpaused", "project-web-analytics-disabled", "project-web-analytics-enabled", "protected-git-scope-added", "protected-git-scope-removed", "runtime-cache-purge-all", "scale", "scale-auto", "secondary-email-added", "secondary-email-removed", "secondary-email-verified", "secret-add", "secret-delete", "secret-rename", "security-plus-updated", "set-bio", "set-name", "set-profiles", "set-scale", "signup", "signup-via-bitbucket", "signup-via-github", "signup-via-gitlab", "speed-insights-settings-updated", "spend-created", "spend-deleted", "spend-updated", "storage-accept-tos", "storage-transfer-request-created", "storage-transfer-out-success", "storage-transfer-in-success", "storage-create", "storage-reset-credentials", "storage-update", "storage-connect-project", "storage-disconnect-project", "storage-update-project-connection", "storage-delete", "storage-accessed-data-browser", "storage-view-secret", "storage-inactive-store-deleted", "storage-resource-repl-command", "storage-disconnect-projects", "storage-access-token-set", "ai-code-review", "ai-alert-investigation", "vercel-agent-team-trial-credits-applied", "team-avatar-update", "team-default-build-machine-updated", "team-delete", "strict-deployment-protection-settings", "team-domain-verification-created", "team-domain-verification-deleted", "team-domain-verification-verified", "team-emu-updated", "vercel-toolbar", "team-email-domain-update", "team-invite-bulk-delete", "team-member-add", "team-member-confirm-request", "team-member-decline-request", "team-member-delete", "team-member-entitlement-added", "team-member-entitlement-canceled", "team-member-entitlement-reactivated", "team-member-entitlement-removed", "team-member-join", "team-member-leave", "team-member-request-access", "team-member-role-update", "team-mfa-enforcement-updated", "concurrent-builds-update", "team-ended-trial", "team-paid-invoice", "team-invite-code-reset", "team-name-update", "team-program-enrollment-changed", "team-remote-caching-update", "enforce-sensitive-environment-variables", "show-ip-addresses", "team-saml-enforced", "team-saml-roles", "team-ip-blocking-rules-created", "team-ip-blocking-rules-removed", "audit-log-export-requested", "audit-log-export-downloaded", "team-slug-update", "unlink-login-connection", "user-mfa-removed", "user-delete", "user-mfa-challenge-verified", "user-mfa-configuration-updated", "user-mfa-recovery-codes-regenerated", "user-mfa-totp-verification-started", "user-mfa-totp-verified", "user-primary-email-updated", "username", "alert-rule-created", "alert-rule-updated", "alert-rule-deleted", "vpc-peering-connection-accepted", "vpc-peering-connection-deleted", "vpc-peering-connection-rejected", "vpc-peering-connection-updated", "web-analytics-tier-updated", "webhook-created", "webhook-deleted", "webhook-updated", "v0-chat-created", "v0-chat-ai-usage", "v0-chat-message-sent", "workflow-deployment-key-accessed" ] }, "createdAt": { "type": "number", "description": "Timestamp (in milliseconds) of when the event was generated." }, "user": { "type": "object", "description": "Metadata for {@link userId}.", "required": [ "avatar", "email", "uid", "username" ], "properties": { "slug": { "type": "string" }, "avatar": { "type": "string" }, "email": { "type": "string" }, "username": { "type": "string" }, "uid": { "type": "string" } } }, "principal": { "oneOf": [ { "type": "object", "description": "Metadata for {@link principalId}.", "required": [ "avatar", "email", "uid", "username" ], "properties": { "type": { "type": "string", "enum": [ "user" ] }, "avatar": { "type": "string" }, "email": { "type": "string" }, "slug": { "type": "string" }, "uid": { "type": "string" }, "username": { "type": "string" } } }, { "type": "object", "description": "Metadata for {@link principalId}.", "required": [ "clientId", "name", "type" ], "properties": { "type": { "type": "string", "enum": [ "app" ] }, "clientId": { "type": "string" }, "name": { "type": "string" } } } ] }, "via": { "type": "array", "description": "Metadata for {@link viaIds}.", "items": { "oneOf": [ { "type": "object", "description": "Metadata for {@link viaIds}.", "required": [ "avatar", "email", "uid", "username" ], "properties": { "type": { "type": "string", "enum": [ "user" ] }, "avatar": { "type": "string" }, "email": { "type": "string" }, "slug": { "type": "string" }, "uid": { "type": "string" }, "username": { "type": "string" } } }, { "type": "object", "description": "Metadata for {@link viaIds}.", "required": [ "clientId", "name", "type" ], "properties": { "type": { "type": "string", "enum": [ "app" ] }, "clientId": { "type": "string" }, "name": { "type": "string" } } } ] } }, "userId": { "type": "string", "description": "When the principal who generated the event is a user, this is their ID; otherwise, it is empty." }, "principalId": { "type": "string", "description": "The ID of the principal who generated the event. The principal is typically a user, but it could also be an app, an integration, etc. The principal may have delegated its authority to an acting party, and so {@link viaIds} should be checked as well." }, "viaIds": { "type": "array", "description": "If the principal delegated its authority (for example, a user delegating to an app), then this array contains the ID of the current actor. For example, if `principalId` is \"user123\" and `viaIds` is `[\"app456\"]`, we can say the event was triggered by - \"app456 on behalf of user123\", or - \"user123 via app4556\". Both are equivalent. Arbitrarily long chains of delegation can be represented. For example, if `principalId` is \"user123\" and `viaIds` is `[\"service1\", \"service2\"]`, we can say the event was triggered by \"user123 via service1 via service2\".", "items": { "type": "string" } }, "payload": { "oneOf": [ { "type": "object", "description": "The payload of the event, if requested." }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "action", "id", "projectId", "slug" ], "properties": { "action": { "type": "string", "enum": [ "deleted", "created", "updated", "archived", "unarchived" ] }, "id": { "type": "string" }, "slug": { "type": "string" }, "projectId": { "type": "string" }, "projectName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "action", "environment" ], "properties": { "action": { "type": "string", "enum": [ "deleted", "added", "rotated" ] }, "label": { "type": "string" }, "projectName": { "type": "string" }, "projectId": { "type": "string" }, "environment": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "action", "environment" ], "properties": { "action": { "type": "string", "enum": [ "read" ] }, "projectName": { "type": "string" }, "projectId": { "type": "string" }, "environment": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "accessGroup" ], "properties": { "accessGroup": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "teamRoles": { "type": "array", "items": { "type": "string" } }, "teamPermissions": { "type": "array", "items": { "type": "string" } }, "entitlements": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "accessGroup", "author" ], "properties": { "author": { "type": "string" }, "accessGroup": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "accessGroup", "project" ], "properties": { "accessGroup": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "project": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "next_role": { "type": "string", "enum": [ "ADMIN", "PROJECT_DEVELOPER", "PROJECT_VIEWER", "PROJECT_GUEST" ], "nullable": true }, "previous_role": { "type": "string", "enum": [ "ADMIN", "PROJECT_DEVELOPER", "PROJECT_VIEWER", "PROJECT_GUEST" ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "accessGroup" ], "properties": { "accessGroup": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "name": { "type": "string" }, "previousName": { "type": "string" }, "teamRoles": { "type": "array", "items": { "type": "string" } }, "previousTeamRoles": { "type": "array", "items": { "type": "string" } }, "teamPermissions": { "type": "array", "items": { "type": "string" } }, "previousTeamPermissions": { "type": "array", "items": { "type": "string" } }, "entitlementsAdded": { "type": "array", "items": { "type": "string" } }, "entitlementsRemoved": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "accessGroup", "user" ], "properties": { "accessGroup": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "user": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "username": { "type": "string" } } }, "directoryType": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "price": { "type": "number" }, "currency": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "alias": { "type": "string" }, "deployment": { "type": "object", "nullable": true, "required": [ "id", "meta", "name", "url" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ruleCount": { "type": "number" }, "deploymentUrl": { "type": "string" }, "aliasId": { "type": "string" }, "deploymentId": { "type": "string", "nullable": true }, "oldDeploymentId": { "type": "string", "nullable": true }, "redirect": { "type": "string" }, "redirectStatusCode": { "type": "number", "nullable": true }, "target": { "type": "string", "nullable": true }, "system": { "type": "boolean", "enum": [ false, true ] }, "aliasUpdatedAt": { "type": "number" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "aliasCount", "projectId" ], "properties": { "projectId": { "type": "string" }, "aliasCount": { "type": "number" }, "deployment": { "type": "object", "nullable": true, "required": [ "id", "meta", "name", "url" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "alias" ], "properties": { "name": { "type": "string" }, "alias": { "type": "string" }, "oldTeam": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } }, "newTeam": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "alias", "aliasId", "deploymentId" ], "properties": { "name": { "type": "string" }, "alias": { "type": "string" }, "aliasId": { "type": "string" }, "deploymentId": { "type": "string", "nullable": true } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "alias": { "type": "string" }, "email": { "type": "string" }, "username": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "alias": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "alias": { "type": "string" }, "email": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "aliasId": { "type": "string" }, "alias": { "type": "string" }, "projectName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "action", "alias", "projectName" ], "properties": { "projectName": { "type": "string" }, "alias": { "type": "string" }, "action": { "type": "string", "enum": [ "created", "removed" ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "alias", "deploymentUrl" ], "properties": { "alias": { "type": "string" }, "deploymentUrl": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "alias": { "type": "string" }, "userId": { "type": "string" }, "username": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "alias": { "type": "string" }, "aliasId": { "type": "string" }, "userId": { "type": "string" }, "username": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "appName", "scopes" ], "properties": { "appName": { "type": "string" }, "appId": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "openid", "email", "profile", "offline_access" ] } }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "*", "read:user", "read:domain", "read-write:domain", "read:team", "read:billing", "read-write:billing", "read-write:ai-gateway-api-key", "use:ai-gateway", "read-write:project-env-vars", "read-write:drains", "read-write:edge-config", "read:monitoring", "read:access-group", "read:integration-configuration", "read-write:integration-configuration", "read-write:integration-resource", "read-write:blob", "read:event", "read-write:remote-cache", "read:project", "read-write:project", "read:deployment", "read-write:deployment", "read-write:edge-cache", "read-write:project-protection-bypass", "read:project-env-vars-non-production", "read-write:project-env-vars-non-production", "read:project-env-vars-production", "read-write:project-env-vars-production", "read-write:project-flags-non-production", "read-write:project-flags-production", "read:project-oidc-token", "read-write:domain-registrar" ] } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "appName" ], "properties": { "appName": { "type": "string" }, "appId": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "appName", "nextScopes" ], "properties": { "appName": { "type": "string" }, "appId": { "type": "string" }, "nextScopes": { "type": "array", "items": { "type": "string", "enum": [ "openid", "email", "profile", "offline_access" ] } }, "nextPermissions": { "type": "array", "items": { "type": "string", "enum": [ "*", "read:user", "read:domain", "read-write:domain", "read:team", "read:billing", "read-write:billing", "read-write:ai-gateway-api-key", "use:ai-gateway", "read-write:project-env-vars", "read-write:drains", "read-write:edge-config", "read:monitoring", "read:access-group", "read:integration-configuration", "read-write:integration-configuration", "read-write:integration-resource", "read-write:blob", "read:event", "read-write:remote-cache", "read:project", "read-write:project", "read:deployment", "read-write:deployment", "read-write:edge-cache", "read-write:project-protection-bypass", "read:project-env-vars-non-production", "read-write:project-env-vars-non-production", "read:project-env-vars-production", "read-write:project-env-vars-production", "read-write:project-flags-non-production", "read-write:project-flags-production", "read:project-oidc-token", "read-write:domain-registrar" ] } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "appName" ], "properties": { "appName": { "type": "string" }, "appId": { "type": "string" }, "installationId": { "type": "string" }, "before": { "type": "object", "properties": { "resources": { "type": "object", "required": [ "projectIds" ], "properties": { "projectIds": { "type": "object", "required": [ "items", "required", "type" ], "properties": { "type": { "type": "string", "enum": [ "list" ] }, "required": { "type": "boolean", "enum": [ true ] }, "items": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "string" ] } } } } } } }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "read:domain", "read-write:domain", "read:team", "read:billing", "read-write:billing", "read-write:ai-gateway-api-key", "use:ai-gateway", "read-write:project-env-vars", "read-write:drains", "read-write:edge-config", "read:monitoring", "read:access-group", "read:integration-configuration", "read-write:integration-configuration", "read-write:integration-resource", "read-write:blob", "read:event", "read-write:remote-cache", "read:project", "read-write:project", "read:deployment", "read-write:deployment", "read-write:edge-cache", "read-write:project-protection-bypass", "read:project-env-vars-non-production", "read-write:project-env-vars-non-production", "read:project-env-vars-production", "read-write:project-env-vars-production", "read-write:project-flags-non-production", "read-write:project-flags-production", "read:project-oidc-token", "read-write:domain-registrar" ] } } } }, "after": { "type": "object", "properties": { "resources": { "type": "object", "required": [ "projectIds" ], "properties": { "projectIds": { "type": "object", "required": [ "items", "required", "type" ], "properties": { "type": { "type": "string", "enum": [ "list" ] }, "required": { "type": "boolean", "enum": [ true ] }, "items": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "string" ] } } } } } } }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "read:domain", "read-write:domain", "read:team", "read:billing", "read-write:billing", "read-write:ai-gateway-api-key", "use:ai-gateway", "read-write:project-env-vars", "read-write:drains", "read-write:edge-config", "read:monitoring", "read:access-group", "read:integration-configuration", "read-write:integration-configuration", "read-write:integration-resource", "read-write:blob", "read:event", "read-write:remote-cache", "read:project", "read-write:project", "read:deployment", "read-write:deployment", "read-write:edge-cache", "read-write:project-protection-bypass", "read:project-env-vars-non-production", "read-write:project-env-vars-non-production", "read:project-env-vars-production", "read-write:project-env-vars-production", "read-write:project-flags-non-production", "read-write:project-flags-production", "read:project-oidc-token", "read-write:domain-registrar" ] } } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "appName" ], "properties": { "appName": { "type": "string" }, "appId": { "type": "string" }, "resources": { "type": "object", "required": [ "projectIds" ], "properties": { "projectIds": { "type": "object", "required": [ "items", "required", "type" ], "properties": { "type": { "type": "string", "enum": [ "list" ] }, "required": { "type": "boolean", "enum": [ true ] }, "items": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "string" ] } } } } } } }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "read:domain", "read-write:domain", "read:team", "read:billing", "read-write:billing", "read-write:ai-gateway-api-key", "use:ai-gateway", "read-write:project-env-vars", "read-write:drains", "read-write:edge-config", "read:monitoring", "read:access-group", "read:integration-configuration", "read-write:integration-configuration", "read-write:integration-resource", "read-write:blob", "read:event", "read-write:remote-cache", "read:project", "read-write:project", "read:deployment", "read-write:deployment", "read-write:edge-cache", "read-write:project-protection-bypass", "read:project-env-vars-non-production", "read-write:project-env-vars-non-production", "read:project-env-vars-production", "read-write:project-env-vars-production", "read-write:project-flags-non-production", "read-write:project-flags-production", "read:project-oidc-token", "read-write:domain-registrar" ] } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "appName" ], "properties": { "appName": { "type": "string" }, "appId": { "type": "string" }, "secretLastFourChars": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "appName" ], "properties": { "appName": { "type": "string", "description": "The App's name at the moment this even was published (it may have changed since then)." }, "appId": { "type": "string", "description": "The App's ID. Note that not all historical events have this field." }, "app": { "type": "object", "description": "Note that not all historical events have this field.", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "The App's ID." }, "name": { "type": "string", "description": "The App's name at the moment this even was published (it may have changed since then)." } } }, "issuedBefore": { "type": "number", "description": "UNIX timestamp in seconds. Tokens issued before this timestamp will be revoked. Note that not all historical events have this field." } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "attackModeEnabled", "projectId" ], "properties": { "projectId": { "type": "string" }, "prevAttackModeEnabled": { "type": "boolean", "enum": [ false, true ] }, "prevAttackModeActiveUntil": { "type": "number", "nullable": true }, "attackModeEnabled": { "type": "boolean", "enum": [ false, true ] }, "attackModeActiveUntil": { "type": "number", "nullable": true } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "autoExposeSystemEnvs", "projectName" ], "properties": { "projectName": { "type": "string" }, "autoExposeSystemEnvs": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "avatar": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "amount", "invoiceId", "lineItemCount", "refundReason" ], "properties": { "invoiceId": { "type": "string" }, "amount": { "type": "number" }, "refundReason": { "type": "string" }, "lineItemCount": { "type": "number" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "amount", "invoiceId", "newInvoiceId", "settlementMethod" ], "properties": { "invoiceId": { "type": "string" }, "newInvoiceId": { "type": "string" }, "settlementMethod": { "type": "string", "enum": [ "refunded-paid", "credited-paid" ] }, "amount": { "type": "number" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "paymentMethodId" ], "properties": { "paymentMethodId": { "type": "string" }, "brand": { "type": "string" }, "last4": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "planSlug" ], "properties": { "subscriptionId": { "type": "string" }, "planSlug": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "action", "data" ], "properties": { "subscriptionId": { "type": "string" }, "action": { "type": "string", "enum": [ "cancel_plan" ] }, "data": { "type": "object", "required": [ "planSlug" ], "properties": { "planSlug": { "type": "string", "enum": [ "v0_teams", "v0_business" ] }, "reason": { "type": "string", "enum": [ "non-payment" ] } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "action", "data" ], "properties": { "subscriptionId": { "type": "string" }, "action": { "type": "string", "enum": [ "resume_plan" ] }, "data": { "type": "object", "required": [ "planSlug" ], "properties": { "planSlug": { "type": "string", "enum": [ "v0_teams", "v0_business" ] } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "action", "data" ], "properties": { "subscriptionId": { "type": "string" }, "action": { "type": "string", "enum": [ "mutate" ] }, "data": { "type": "object", "additionalProperties": true } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "productAliases" ], "properties": { "subscriptionId": { "type": "string" }, "productAliases": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "bulkRedirectsLimit", "prevBulkRedirectsLimit", "project" ], "properties": { "project": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "bulkRedirectsLimit": { "type": "number" }, "prevBulkRedirectsLimit": { "type": "number" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "project", "versionId" ], "properties": { "project": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "versionId": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "custom" ], "properties": { "cn": { "type": "string" }, "cns": { "type": "array", "items": { "type": "string" } }, "custom": { "type": "boolean", "enum": [ false, true ] }, "id": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "cns", "custom", "id" ], "properties": { "id": { "type": "string" }, "cns": { "type": "array", "items": { "type": "string" } }, "custom": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "cn": { "type": "string" }, "cns": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "id" ], "properties": { "id": { "type": "string" }, "oldTeam": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } }, "newTeam": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "dst", "src" ], "properties": { "src": { "type": "string" }, "dst": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "id" ], "properties": { "id": { "type": "string" }, "cn": { "type": "string" }, "cns": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "cn": { "type": "string" }, "cns": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "configuration" ], "properties": { "configuration": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "configuration", "project", "team" ], "properties": { "team": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "configuration": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "project": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "buildsEnabled": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "configuration", "project", "team" ], "properties": { "team": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "configuration": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "project": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "buildsEnabled": { "type": "boolean", "enum": [ false, true ] }, "passive": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "configuration", "project", "team" ], "properties": { "team": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "configuration": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "project": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "configuration", "newName", "team" ], "properties": { "team": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "configuration": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "newName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "githubLogin" ], "properties": { "githubLogin": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "githubLogin", "host" ], "properties": { "githubLogin": { "type": "string" }, "host": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "gitlabEmail", "gitlabLogin" ], "properties": { "gitlabLogin": { "type": "string" }, "gitlabEmail": { "type": "string" }, "gitlabName": { "type": "string" }, "zeitAccount": { "type": "string" }, "zeitAccountType": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "gitlabLogin", "gitlabUserId" ], "properties": { "gitlabLogin": { "type": "string" }, "gitlabUserId": { "type": "number" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "bitbucketEmail", "bitbucketLogin" ], "properties": { "bitbucketEmail": { "type": "string" }, "bitbucketLogin": { "type": "string" }, "bitbucketName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "bitbucketAccountId", "bitbucketLogin" ], "properties": { "bitbucketLogin": { "type": "string" }, "bitbucketAccountId": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "suffix" ], "properties": { "reason": { "type": "string" }, "suffix": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "status", "suffix" ], "properties": { "status": { "type": "string" }, "suffix": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "suffix" ], "properties": { "suffix": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "hookName", "projectId", "projectName", "ref" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "hookName": { "type": "string" }, "ref": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "job", "project" ], "properties": { "project": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } }, "job": { "type": "object", "required": [ "deployHook", "state" ], "properties": { "deployHook": { "type": "object", "required": [ "createdAt", "id", "name", "ref" ], "properties": { "createdAt": { "type": "number" }, "id": { "type": "string" }, "name": { "type": "string" }, "ref": { "type": "string" } } }, "state": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "checkId", "checkName", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "checkId": { "type": "string" }, "checkName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "url" ], "properties": { "name": { "type": "string" }, "alias": { "type": "array", "items": { "type": "string" } }, "target": { "type": "string", "nullable": true }, "deployment": { "type": "object", "nullable": true, "required": [ "id", "meta", "name", "url" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "string" } } } }, "url": { "type": "string" }, "forced": { "type": "boolean", "enum": [ false, true ] }, "deploymentId": { "type": "string" }, "plan": { "type": "string" }, "project": { "type": "string" }, "projectId": { "type": "string" }, "regions": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "job" ], "properties": { "job": { "oneOf": [ { "type": "object", "required": [ "headInfo", "name", "owner", "provider", "ref", "repoUuid", "sha", "slug", "type", "workspaceUuid" ], "properties": { "type": { "type": "string", "enum": [ "bitbucket-push" ] }, "authorized": { "type": "boolean", "enum": [ false, true ] }, "authorizedBy": { "type": "string" }, "jobProjectIds": { "type": "array", "description": "Since December 2022 All project ids associated to this job. Think monorepo. This job will be for one of these project.", "items": { "type": "string" } }, "jobPairs": { "type": "array", "description": "Since December 2022 Pairs of projects and owner ids to build for this build request.", "items": { "type": "array", "description": "Since December 2022 Pairs of projects and owner ids to build for this build request.", "items": { "oneOf": [ { "type": "string" }, { "type": "string" } ] } } }, "skippedJobPairs": { "type": "array", "description": "Since June 2024 Pairs of projects and owner ids to immediately finish (without building) because we want to create them in a skipped state.", "items": { "type": "array", "description": "Since June 2024 Pairs of projects and owner ids to immediately finish (without building) because we want to create them in a skipped state.", "items": { "oneOf": [ { "type": "string" }, { "type": "string" } ] } } }, "gitHashtagVercel": { "type": "array", "description": "Since February 2022 All the hashtag-vercel tags found in the commit message triggering the deploy. For example, #VERCEL_DO_SOMETHING", "items": { "type": "string", "description": "Since February 2022 All the hashtag-vercel tags found in the commit message triggering the deploy. For example, #VERCEL_DO_SOMETHING", "enum": [ "#VERCEL_SDDJ_BEFORE_BUILD_JOB_QUEUED_ERROR", "#VERCEL_SDDJ_AFTER_GET_REPO_FORCE_ERROR", "#VERCEL_SDDJ_AFTER_GET_REPO_FORCE_CANCEL", "#VERCEL_SDDJ_AFTER_VERIFY_FORCE_ERROR", "#VERCEL_SDDJ_AFTER_VERIFY_FORCE_CANCEL", "#VERCEL_SDDJ_FORCE_GIT_FORK_ERROR", "#VERCEL_BUILD_PRIO_1", "#VERCEL_BUILD_PRIO_2", "#VERCEL_BUILD_PRIO_3", "#VERCEL_BUILD_PRIO_4", "#VERCEL_BUILD_PRIO_5", "#VERCEL_BUILD_PRIO_6", "#VERCEL_BUILD_PRIO_7", "#VERCEL_BUILD_PRIO_8", "#VERCEL_BUILD_PRIO_9", "#VERCEL_BUILD_PRIO_10", "#VERCEL_SKIP", "#VERCEL_V0_MESSAGE" ] } }, "connectedProjectCount": { "type": "number", "description": "Since April 2023 Cached count of how many projects are connected to the repo. Saves a few Cosmos queries down the road in the main flow." }, "prIdOrZero": { "type": "number", "description": "Since April 2023 If set then it is a cached result of asking the remote for the PR ID the commit that triggered this Job. Or zero if it was not a PR. This prevents a few git round trips by the git updater." }, "gitComments": { "type": "object", "description": "Since June 2023 Determines if comments should be posted to the git host. Replaces `github.silent` in the vercel.json.", "required": [ "onCommit", "onPullRequest" ], "properties": { "onPullRequest": { "type": "boolean", "enum": [ false, true ] }, "onCommit": { "type": "boolean", "enum": [ false, true ] } } }, "isManualGitDeploy": { "type": "boolean", "description": "Since 28 Feb 2024 If set to true, identifies that the git job was created for a manual git deployment", "enum": [ false, true ] }, "commitVerification": { "type": "string", "description": "Since 6 Nov 2025 The verification status of the commit. - 'verified' if the commit is verified - 'unverified' if the commit is not verified - 'unknown' if the commit verification status is unknown or not supported", "enum": [ "verified", "unverified", "unknown" ] }, "nsnbSideEffect": { "type": "object", "description": "Since March 2026 Records a successful NSNB auto-add result so later GitHub PR comments can deterministically explain why this SHA was allowed to deploy.", "required": [ "action", "gitUserLogin" ], "properties": { "action": { "type": "string", "enum": [ "auto-approved-member", "auto-approved-pending-invite" ] }, "gitUserLogin": { "type": "string" } } }, "createdAt": { "type": "number" }, "deploymentId": { "type": "string" }, "deployHook": { "type": "object", "required": [ "createdAt", "id", "name", "ref" ], "properties": { "createdAt": { "type": "number" }, "id": { "type": "string" }, "name": { "type": "string" }, "ref": { "type": "string" } } }, "eventful": { "type": "boolean", "enum": [ false, true ] }, "forceNew": { "type": "boolean", "enum": [ false, true ] }, "headInfo": { "type": "object", "required": [ "owner", "ref", "repoUuid", "sha", "slug" ], "properties": { "owner": { "type": "string" }, "ref": { "type": "string" }, "repoUuid": { "type": "string" }, "sha": { "type": "string" }, "slug": { "type": "string" } } }, "linkedProjectId": { "type": "string" }, "name": { "type": "string" }, "owner": { "type": "string" }, "prId": { "type": "number" }, "projectId": { "type": "string" }, "customEnvId": { "type": "string", "nullable": true }, "ref": { "type": "string" }, "repoPushedAt": { "type": "number", "nullable": true }, "repoUuid": { "type": "string" }, "sha": { "type": "string" }, "silent": { "type": "boolean", "enum": [ false, true ] }, "slug": { "type": "string" }, "target": { "type": "string", "nullable": true }, "url": { "type": "string" }, "withCache": { "type": "boolean", "enum": [ false, true ] }, "workspaceUuid": { "type": "string" }, "provider": { "type": "string", "enum": [ "bitbucket" ] } } }, { "type": "object", "description": "Represents the payload for a Bitbucket comment job This interface defines the structure of data needed when creating a job to handle comments on Bitbucket pull requests or commits.", "required": [ "headInfo", "name", "owner", "prId", "provider", "ref", "repoUuid", "sha", "slug", "type", "workspaceUuid" ], "properties": { "createdAt": { "type": "number" }, "eventful": { "type": "boolean", "enum": [ false, true ] }, "headInfo": { "type": "object", "required": [ "owner", "ref", "repoUuid", "sha", "slug" ], "properties": { "owner": { "type": "string" }, "ref": { "type": "string" }, "repoUuid": { "type": "string" }, "sha": { "type": "string" }, "slug": { "type": "string" } } }, "linkedProjectId": { "type": "string" }, "name": { "type": "string" }, "owner": { "type": "string" }, "prId": { "type": "number" }, "projectId": { "type": "string" }, "customEnvId": { "type": "string", "nullable": true }, "ref": { "type": "string" }, "repoUuid": { "type": "string" }, "sha": { "type": "string" }, "slug": { "type": "string" }, "type": { "type": "string", "enum": [ "bitbucket-now-comment" ] }, "workspaceUuid": { "type": "string" }, "gitComments": { "type": "object", "required": [ "onCommit", "onPullRequest" ], "properties": { "onPullRequest": { "type": "boolean", "enum": [ false, true ] }, "onCommit": { "type": "boolean", "enum": [ false, true ] } } }, "provider": { "type": "string", "enum": [ "bitbucket" ] } } }, { "type": "object", "required": [ "headInfo", "installationId", "isPrivate", "org", "prId", "provider", "repo", "repoId", "type" ], "properties": { "prId": { "type": "number" }, "type": { "type": "string", "enum": [ "pr" ] }, "authorized": { "type": "boolean", "enum": [ false, true ] }, "authorizedBy": { "type": "string" }, "jobProjectIds": { "type": "array", "description": "Since December 2022 All project ids associated to this job. Think monorepo. This job will be for one of these project.", "items": { "type": "string" } }, "jobPairs": { "type": "array", "description": "Since December 2022 Pairs of projects and owner ids to build for this build request.", "items": { "type": "array", "description": "Since December 2022 Pairs of projects and owner ids to build for this build request.", "items": { "oneOf": [ { "type": "string" }, { "type": "string" } ] } } }, "skippedJobPairs": { "type": "array", "description": "Since June 2024 Pairs of projects and owner ids to immediately finish (without building) because we want to create them in a skipped state.", "items": { "type": "array", "description": "Since June 2024 Pairs of projects and owner ids to immediately finish (without building) because we want to create them in a skipped state.", "items": { "oneOf": [ { "type": "string" }, { "type": "string" } ] } } }, "gitHashtagVercel": { "type": "array", "description": "Since February 2022 All the hashtag-vercel tags found in the commit message triggering the deploy. For example, #VERCEL_DO_SOMETHING", "items": { "type": "string", "description": "Since February 2022 All the hashtag-vercel tags found in the commit message triggering the deploy. For example, #VERCEL_DO_SOMETHING", "enum": [ "#VERCEL_SDDJ_BEFORE_BUILD_JOB_QUEUED_ERROR", "#VERCEL_SDDJ_AFTER_GET_REPO_FORCE_ERROR", "#VERCEL_SDDJ_AFTER_GET_REPO_FORCE_CANCEL", "#VERCEL_SDDJ_AFTER_VERIFY_FORCE_ERROR", "#VERCEL_SDDJ_AFTER_VERIFY_FORCE_CANCEL", "#VERCEL_SDDJ_FORCE_GIT_FORK_ERROR", "#VERCEL_BUILD_PRIO_1", "#VERCEL_BUILD_PRIO_2", "#VERCEL_BUILD_PRIO_3", "#VERCEL_BUILD_PRIO_4", "#VERCEL_BUILD_PRIO_5", "#VERCEL_BUILD_PRIO_6", "#VERCEL_BUILD_PRIO_7", "#VERCEL_BUILD_PRIO_8", "#VERCEL_BUILD_PRIO_9", "#VERCEL_BUILD_PRIO_10", "#VERCEL_SKIP", "#VERCEL_V0_MESSAGE" ] } }, "connectedProjectCount": { "type": "number", "description": "Since April 2023 Cached count of how many projects are connected to the repo. Saves a few Cosmos queries down the road in the main flow." }, "prIdOrZero": { "type": "number", "description": "Since April 2023 If set then it is a cached result of asking the remote for the PR ID the commit that triggered this Job. Or zero if it was not a PR. This prevents a few git round trips by the git updater." }, "gitComments": { "type": "object", "description": "Since June 2023 Determines if comments should be posted to the git host. Replaces `github.silent` in the vercel.json.", "required": [ "onCommit", "onPullRequest" ], "properties": { "onPullRequest": { "type": "boolean", "enum": [ false, true ] }, "onCommit": { "type": "boolean", "enum": [ false, true ] } } }, "isManualGitDeploy": { "type": "boolean", "description": "Since 28 Feb 2024 If set to true, identifies that the git job was created for a manual git deployment", "enum": [ false, true ] }, "commitVerification": { "type": "string", "description": "Since 6 Nov 2025 The verification status of the commit. - 'verified' if the commit is verified - 'unverified' if the commit is not verified - 'unknown' if the commit verification status is unknown or not supported", "enum": [ "verified", "unverified", "unknown" ] }, "nsnbSideEffect": { "type": "object", "description": "Since March 2026 Records a successful NSNB auto-add result so later GitHub PR comments can deterministically explain why this SHA was allowed to deploy.", "required": [ "action", "gitUserLogin" ], "properties": { "action": { "type": "string", "enum": [ "auto-approved-member", "auto-approved-pending-invite" ] }, "gitUserLogin": { "type": "string" } } }, "committerGitUserId": { "type": "number", "description": "Remote account id of the committer details (github id etc, not vercel). Note that the committer name/email are user input verbatim and not verified. Github does appear to resolve the given email to the username so we can trust that. If the username matches that of the sender, which is verified info, then we can use the account id and account type. See api-incoming, where we determine and set this property Note that even with that, the account may still have been spoofed." }, "committerGitUserType": { "type": "string", "description": "Remote account type of the committer details (github type etc, not vercel). Note that the committer name/email are user input verbatim and not verified. Github does appear to resolve the given email to the username so we can trust that. If the username matches that of the sender, which is verified info, then we can use the account id and account type. See api-incoming, where we determine and set this property Note that even with that, the account may still have been spoofed." }, "createdAt": { "type": "number" }, "forceNew": { "type": "boolean", "enum": [ false, true ] }, "deploymentId": { "type": "string" }, "deployHook": { "type": "object", "required": [ "createdAt", "id", "name", "ref" ], "properties": { "createdAt": { "type": "number" }, "id": { "type": "string" }, "name": { "type": "string" }, "ref": { "type": "string" } } }, "beforeSha": { "type": "string" }, "defaultBranch": { "type": "string" }, "eventful": { "type": "boolean", "enum": [ false, true ] }, "githubDeploymentId": { "type": "string" }, "headInfo": { "type": "object", "description": "Information about the head commit/branch for a GitHub repository", "required": [ "org", "ref", "repo", "repoId", "sha" ], "properties": { "org": { "type": "string" }, "ref": { "type": "string" }, "repo": { "type": "string" }, "repoId": { "type": "number" }, "sha": { "type": "string" } } }, "installationId": { "type": "number" }, "isPrivate": { "type": "boolean", "enum": [ false, true ] }, "linkedProjectId": { "type": "string" }, "org": { "type": "string" }, "projectId": { "type": "string" }, "customEnvId": { "type": "string", "nullable": true }, "repo": { "type": "string" }, "repoId": { "type": "number" }, "target": { "type": "string", "nullable": true }, "url": { "type": "string" }, "withCache": { "type": "boolean", "enum": [ false, true ] }, "provider": { "type": "string", "enum": [ "github", "github-limited", "github-custom-host" ] }, "customHost": { "type": "string" } } }, { "type": "object", "required": [ "headInfo", "installationId", "isPrivate", "org", "prId", "provider", "repo", "repoId", "repoPushedAt", "type" ], "properties": { "repoPushedAt": { "type": "number", "nullable": true }, "commitInfo": { "type": "object", "required": [ "total" ], "properties": { "total": { "type": "number" }, "earliestSha": { "type": "string" } } }, "forced": { "type": "boolean", "enum": [ false, true ] }, "type": { "type": "string", "enum": [ "push" ] }, "authorized": { "type": "boolean", "enum": [ false, true ] }, "authorizedBy": { "type": "string" }, "jobProjectIds": { "type": "array", "description": "Since December 2022 All project ids associated to this job. Think monorepo. This job will be for one of these project.", "items": { "type": "string" } }, "jobPairs": { "type": "array", "description": "Since December 2022 Pairs of projects and owner ids to build for this build request.", "items": { "type": "array", "description": "Since December 2022 Pairs of projects and owner ids to build for this build request.", "items": { "oneOf": [ { "type": "string" }, { "type": "string" } ] } } }, "skippedJobPairs": { "type": "array", "description": "Since June 2024 Pairs of projects and owner ids to immediately finish (without building) because we want to create them in a skipped state.", "items": { "type": "array", "description": "Since June 2024 Pairs of projects and owner ids to immediately finish (without building) because we want to create them in a skipped state.", "items": { "oneOf": [ { "type": "string" }, { "type": "string" } ] } } }, "gitHashtagVercel": { "type": "array", "description": "Since February 2022 All the hashtag-vercel tags found in the commit message triggering the deploy. For example, #VERCEL_DO_SOMETHING", "items": { "type": "string", "description": "Since February 2022 All the hashtag-vercel tags found in the commit message triggering the deploy. For example, #VERCEL_DO_SOMETHING", "enum": [ "#VERCEL_SDDJ_BEFORE_BUILD_JOB_QUEUED_ERROR", "#VERCEL_SDDJ_AFTER_GET_REPO_FORCE_ERROR", "#VERCEL_SDDJ_AFTER_GET_REPO_FORCE_CANCEL", "#VERCEL_SDDJ_AFTER_VERIFY_FORCE_ERROR", "#VERCEL_SDDJ_AFTER_VERIFY_FORCE_CANCEL", "#VERCEL_SDDJ_FORCE_GIT_FORK_ERROR", "#VERCEL_BUILD_PRIO_1", "#VERCEL_BUILD_PRIO_2", "#VERCEL_BUILD_PRIO_3", "#VERCEL_BUILD_PRIO_4", "#VERCEL_BUILD_PRIO_5", "#VERCEL_BUILD_PRIO_6", "#VERCEL_BUILD_PRIO_7", "#VERCEL_BUILD_PRIO_8", "#VERCEL_BUILD_PRIO_9", "#VERCEL_BUILD_PRIO_10", "#VERCEL_SKIP", "#VERCEL_V0_MESSAGE" ] } }, "connectedProjectCount": { "type": "number", "description": "Since April 2023 Cached count of how many projects are connected to the repo. Saves a few Cosmos queries down the road in the main flow." }, "prIdOrZero": { "type": "number", "description": "Since April 2023 If set then it is a cached result of asking the remote for the PR ID the commit that triggered this Job. Or zero if it was not a PR. This prevents a few git round trips by the git updater." }, "gitComments": { "type": "object", "description": "Since June 2023 Determines if comments should be posted to the git host. Replaces `github.silent` in the vercel.json.", "required": [ "onCommit", "onPullRequest" ], "properties": { "onPullRequest": { "type": "boolean", "enum": [ false, true ] }, "onCommit": { "type": "boolean", "enum": [ false, true ] } } }, "isManualGitDeploy": { "type": "boolean", "description": "Since 28 Feb 2024 If set to true, identifies that the git job was created for a manual git deployment", "enum": [ false, true ] }, "commitVerification": { "type": "string", "description": "Since 6 Nov 2025 The verification status of the commit. - 'verified' if the commit is verified - 'unverified' if the commit is not verified - 'unknown' if the commit verification status is unknown or not supported", "enum": [ "verified", "unverified", "unknown" ] }, "nsnbSideEffect": { "type": "object", "description": "Since March 2026 Records a successful NSNB auto-add result so later GitHub PR comments can deterministically explain why this SHA was allowed to deploy.", "required": [ "action", "gitUserLogin" ], "properties": { "action": { "type": "string", "enum": [ "auto-approved-member", "auto-approved-pending-invite" ] }, "gitUserLogin": { "type": "string" } } }, "committerGitUserId": { "type": "number", "description": "Remote account id of the committer details (github id etc, not vercel). Note that the committer name/email are user input verbatim and not verified. Github does appear to resolve the given email to the username so we can trust that. If the username matches that of the sender, which is verified info, then we can use the account id and account type. See api-incoming, where we determine and set this property Note that even with that, the account may still have been spoofed." }, "committerGitUserType": { "type": "string", "description": "Remote account type of the committer details (github type etc, not vercel). Note that the committer name/email are user input verbatim and not verified. Github does appear to resolve the given email to the username so we can trust that. If the username matches that of the sender, which is verified info, then we can use the account id and account type. See api-incoming, where we determine and set this property Note that even with that, the account may still have been spoofed." }, "createdAt": { "type": "number" }, "forceNew": { "type": "boolean", "enum": [ false, true ] }, "deploymentId": { "type": "string" }, "deployHook": { "type": "object", "required": [ "createdAt", "id", "name", "ref" ], "properties": { "createdAt": { "type": "number" }, "id": { "type": "string" }, "name": { "type": "string" }, "ref": { "type": "string" } } }, "beforeSha": { "type": "string" }, "defaultBranch": { "type": "string" }, "eventful": { "type": "boolean", "enum": [ false, true ] }, "githubDeploymentId": { "type": "string" }, "headInfo": { "type": "object", "description": "Information about the head commit/branch for a GitHub repository", "required": [ "org", "ref", "repo", "repoId", "sha" ], "properties": { "org": { "type": "string" }, "ref": { "type": "string" }, "repo": { "type": "string" }, "repoId": { "type": "number" }, "sha": { "type": "string" } } }, "installationId": { "type": "number" }, "isPrivate": { "type": "boolean", "enum": [ false, true ] }, "linkedProjectId": { "type": "string" }, "org": { "type": "string" }, "prId": { "type": "number", "nullable": true }, "projectId": { "type": "string" }, "customEnvId": { "type": "string", "nullable": true }, "repo": { "type": "string" }, "repoId": { "type": "number" }, "target": { "type": "string", "nullable": true }, "url": { "type": "string" }, "withCache": { "type": "boolean", "enum": [ false, true ] }, "provider": { "type": "string", "enum": [ "github", "github-limited", "github-custom-host" ] }, "customHost": { "type": "string" } } }, { "type": "object", "required": [ "headInfo", "installationId", "isPrivate", "org", "prId", "projectId", "provider", "repo", "repoId", "type" ], "properties": { "createdAt": { "type": "number" }, "eventful": { "type": "boolean", "enum": [ false, true ] }, "headInfo": { "type": "object", "description": "Information about the head commit/branch for a GitHub repository", "required": [ "org", "ref", "repo", "repoId", "sha" ], "properties": { "org": { "type": "string" }, "ref": { "type": "string" }, "repo": { "type": "string" }, "repoId": { "type": "number" }, "sha": { "type": "string" } } }, "beforeSha": { "type": "string" }, "installationId": { "type": "number" }, "isPrivate": { "type": "boolean", "enum": [ false, true ] }, "linkedProjectId": { "type": "string" }, "org": { "type": "string" }, "prId": { "type": "number" }, "projectId": { "nullable": true }, "customEnvId": { "nullable": true }, "repo": { "type": "string" }, "repoId": { "type": "number" }, "type": { "type": "string", "enum": [ "now-comment" ] }, "gitComments": { "type": "object", "required": [ "onCommit", "onPullRequest" ], "properties": { "onPullRequest": { "type": "boolean", "enum": [ false, true ] }, "onCommit": { "type": "boolean", "enum": [ false, true ] } } }, "provider": { "type": "string", "enum": [ "github", "github-limited", "github-custom-host" ] }, "customHost": { "type": "string" } } }, { "type": "object", "required": [ "headInfo", "project", "provider", "ref", "sha", "type" ], "properties": { "type": { "type": "string", "enum": [ "gitlab-push" ] }, "authorized": { "type": "boolean", "enum": [ false, true ] }, "authorizedBy": { "type": "string" }, "jobProjectIds": { "type": "array", "description": "Since December 2022 All project ids associated to this job. Think monorepo. This job will be for one of these project.", "items": { "type": "string" } }, "jobPairs": { "type": "array", "description": "Since December 2022 Pairs of projects and owner ids to build for this build request.", "items": { "type": "array", "description": "Since December 2022 Pairs of projects and owner ids to build for this build request.", "items": { "oneOf": [ { "type": "string" }, { "type": "string" } ] } } }, "skippedJobPairs": { "type": "array", "description": "Since June 2024 Pairs of projects and owner ids to immediately finish (without building) because we want to create them in a skipped state.", "items": { "type": "array", "description": "Since June 2024 Pairs of projects and owner ids to immediately finish (without building) because we want to create them in a skipped state.", "items": { "oneOf": [ { "type": "string" }, { "type": "string" } ] } } }, "gitHashtagVercel": { "type": "array", "description": "Since February 2022 All the hashtag-vercel tags found in the commit message triggering the deploy. For example, #VERCEL_DO_SOMETHING", "items": { "type": "string", "description": "Since February 2022 All the hashtag-vercel tags found in the commit message triggering the deploy. For example, #VERCEL_DO_SOMETHING", "enum": [ "#VERCEL_SDDJ_BEFORE_BUILD_JOB_QUEUED_ERROR", "#VERCEL_SDDJ_AFTER_GET_REPO_FORCE_ERROR", "#VERCEL_SDDJ_AFTER_GET_REPO_FORCE_CANCEL", "#VERCEL_SDDJ_AFTER_VERIFY_FORCE_ERROR", "#VERCEL_SDDJ_AFTER_VERIFY_FORCE_CANCEL", "#VERCEL_SDDJ_FORCE_GIT_FORK_ERROR", "#VERCEL_BUILD_PRIO_1", "#VERCEL_BUILD_PRIO_2", "#VERCEL_BUILD_PRIO_3", "#VERCEL_BUILD_PRIO_4", "#VERCEL_BUILD_PRIO_5", "#VERCEL_BUILD_PRIO_6", "#VERCEL_BUILD_PRIO_7", "#VERCEL_BUILD_PRIO_8", "#VERCEL_BUILD_PRIO_9", "#VERCEL_BUILD_PRIO_10", "#VERCEL_SKIP", "#VERCEL_V0_MESSAGE" ] } }, "connectedProjectCount": { "type": "number", "description": "Since April 2023 Cached count of how many projects are connected to the repo. Saves a few Cosmos queries down the road in the main flow." }, "prIdOrZero": { "type": "number", "description": "Since April 2023 If set then it is a cached result of asking the remote for the PR ID the commit that triggered this Job. Or zero if it was not a PR. This prevents a few git round trips by the git updater." }, "gitComments": { "type": "object", "description": "Since June 2023 Determines if comments should be posted to the git host. Replaces `github.silent` in the vercel.json.", "required": [ "onCommit", "onPullRequest" ], "properties": { "onPullRequest": { "type": "boolean", "enum": [ false, true ] }, "onCommit": { "type": "boolean", "enum": [ false, true ] } } }, "isManualGitDeploy": { "type": "boolean", "description": "Since 28 Feb 2024 If set to true, identifies that the git job was created for a manual git deployment", "enum": [ false, true ] }, "commitVerification": { "type": "string", "description": "Since 6 Nov 2025 The verification status of the commit. - 'verified' if the commit is verified - 'unverified' if the commit is not verified - 'unknown' if the commit verification status is unknown or not supported", "enum": [ "verified", "unverified", "unknown" ] }, "nsnbSideEffect": { "type": "object", "description": "Since March 2026 Records a successful NSNB auto-add result so later GitHub PR comments can deterministically explain why this SHA was allowed to deploy.", "required": [ "action", "gitUserLogin" ], "properties": { "action": { "type": "string", "enum": [ "auto-approved-member", "auto-approved-pending-invite" ] }, "gitUserLogin": { "type": "string" } } }, "commit": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "authorAvatar": { "type": "string", "nullable": true }, "authorEmail": { "type": "string", "nullable": true }, "authorId": { "type": "number", "nullable": true }, "authorLogin": { "type": "string", "nullable": true }, "authorName": { "type": "string", "nullable": true } } }, "createdAt": { "type": "number" }, "deployHook": { "type": "object", "required": [ "createdAt", "id", "name", "ref" ], "properties": { "createdAt": { "type": "number" }, "id": { "type": "string" }, "name": { "type": "string" }, "ref": { "type": "string" } } }, "deploymentId": { "type": "string" }, "eventful": { "type": "boolean", "enum": [ false, true ] }, "forceNew": { "type": "boolean", "enum": [ false, true ] }, "headInfo": { "type": "object", "description": "GitLab", "required": [ "project", "ref", "sha" ], "properties": { "project": { "type": "object", "required": [ "id" ], "properties": { "defaultBranch": { "type": "string", "nullable": true }, "id": { "type": "string" }, "name": { "type": "string", "nullable": true }, "namespace": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } } }, "ref": { "type": "string" }, "sha": { "type": "string" } } }, "linkedProjectId": { "type": "string" }, "prId": { "type": "number" }, "project": { "type": "object", "required": [ "id" ], "properties": { "defaultBranch": { "type": "string", "nullable": true }, "id": { "type": "string" }, "name": { "type": "string", "nullable": true }, "namespace": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } } }, "projectId": { "type": "string" }, "customEnvId": { "type": "string", "nullable": true }, "ref": { "type": "string" }, "repoPushedAt": { "type": "number", "nullable": true }, "sha": { "type": "string" }, "silent": { "type": "boolean", "enum": [ false, true ] }, "target": { "type": "string", "nullable": true }, "url": { "type": "string" }, "withCache": { "type": "boolean", "enum": [ false, true ] }, "provider": { "type": "string", "enum": [ "gitlab" ] } } }, { "type": "object", "required": [ "headInfo", "prId", "project", "provider", "ref", "sha", "type" ], "properties": { "createdAt": { "type": "number" }, "eventful": { "type": "boolean", "enum": [ false, true ] }, "headInfo": { "type": "object", "description": "GitLab", "required": [ "project", "ref", "sha" ], "properties": { "project": { "type": "object", "required": [ "id" ], "properties": { "defaultBranch": { "type": "string", "nullable": true }, "id": { "type": "string" }, "name": { "type": "string", "nullable": true }, "namespace": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } } }, "ref": { "type": "string" }, "sha": { "type": "string" } } }, "linkedProjectId": { "type": "string" }, "prId": { "type": "number" }, "project": { "type": "object", "required": [ "id" ], "properties": { "defaultBranch": { "type": "string", "nullable": true }, "id": { "type": "string" }, "name": { "type": "string", "nullable": true }, "namespace": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } } }, "projectId": { "type": "string" }, "customEnvId": { "type": "string", "nullable": true }, "ref": { "type": "string" }, "sha": { "type": "string" }, "type": { "type": "string", "enum": [ "gitlab-now-comment" ] }, "gitComments": { "type": "object", "required": [ "onCommit", "onPullRequest" ], "properties": { "onPullRequest": { "type": "boolean", "enum": [ false, true ] }, "onCommit": { "type": "boolean", "enum": [ false, true ] } } }, "provider": { "type": "string", "enum": [ "gitlab" ] } } }, { "type": "object", "required": [ "headInfo", "org", "provider", "ref", "repo", "sha", "type" ], "properties": { "type": { "type": "string", "enum": [ "vercel-push" ] }, "ref": { "type": "string" }, "repo": { "type": "string" }, "sha": { "type": "string" }, "repoPushedAt": { "type": "number", "nullable": true }, "deployHook": { "type": "object", "required": [ "createdAt", "id", "name", "ref" ], "properties": { "createdAt": { "type": "number" }, "id": { "type": "string" }, "name": { "type": "string" }, "ref": { "type": "string" } } }, "url": { "type": "string" }, "target": { "type": "string", "nullable": true }, "deploymentId": { "type": "string" }, "linkedProjectId": { "type": "string" }, "projectId": { "type": "string" }, "authorized": { "type": "boolean", "enum": [ false, true ] }, "authorizedBy": { "type": "string" }, "jobProjectIds": { "type": "array", "description": "Since December 2022 All project ids associated to this job. Think monorepo. This job will be for one of these project.", "items": { "type": "string" } }, "jobPairs": { "type": "array", "description": "Since December 2022 Pairs of projects and owner ids to build for this build request.", "items": { "type": "array", "description": "Since December 2022 Pairs of projects and owner ids to build for this build request.", "items": { "oneOf": [ { "type": "string" }, { "type": "string" } ] } } }, "skippedJobPairs": { "type": "array", "description": "Since June 2024 Pairs of projects and owner ids to immediately finish (without building) because we want to create them in a skipped state.", "items": { "type": "array", "description": "Since June 2024 Pairs of projects and owner ids to immediately finish (without building) because we want to create them in a skipped state.", "items": { "oneOf": [ { "type": "string" }, { "type": "string" } ] } } }, "gitHashtagVercel": { "type": "array", "description": "Since February 2022 All the hashtag-vercel tags found in the commit message triggering the deploy. For example, #VERCEL_DO_SOMETHING", "items": { "type": "string", "description": "Since February 2022 All the hashtag-vercel tags found in the commit message triggering the deploy. For example, #VERCEL_DO_SOMETHING", "enum": [ "#VERCEL_SDDJ_BEFORE_BUILD_JOB_QUEUED_ERROR", "#VERCEL_SDDJ_AFTER_GET_REPO_FORCE_ERROR", "#VERCEL_SDDJ_AFTER_GET_REPO_FORCE_CANCEL", "#VERCEL_SDDJ_AFTER_VERIFY_FORCE_ERROR", "#VERCEL_SDDJ_AFTER_VERIFY_FORCE_CANCEL", "#VERCEL_SDDJ_FORCE_GIT_FORK_ERROR", "#VERCEL_BUILD_PRIO_1", "#VERCEL_BUILD_PRIO_2", "#VERCEL_BUILD_PRIO_3", "#VERCEL_BUILD_PRIO_4", "#VERCEL_BUILD_PRIO_5", "#VERCEL_BUILD_PRIO_6", "#VERCEL_BUILD_PRIO_7", "#VERCEL_BUILD_PRIO_8", "#VERCEL_BUILD_PRIO_9", "#VERCEL_BUILD_PRIO_10", "#VERCEL_SKIP", "#VERCEL_V0_MESSAGE" ] } }, "connectedProjectCount": { "type": "number", "description": "Since April 2023 Cached count of how many projects are connected to the repo. Saves a few Cosmos queries down the road in the main flow." }, "prIdOrZero": { "type": "number", "description": "Since April 2023 If set then it is a cached result of asking the remote for the PR ID the commit that triggered this Job. Or zero if it was not a PR. This prevents a few git round trips by the git updater." }, "gitComments": { "type": "object", "description": "Since June 2023 Determines if comments should be posted to the git host. Replaces `github.silent` in the vercel.json.", "required": [ "onCommit", "onPullRequest" ], "properties": { "onPullRequest": { "type": "boolean", "enum": [ false, true ] }, "onCommit": { "type": "boolean", "enum": [ false, true ] } } }, "isManualGitDeploy": { "type": "boolean", "description": "Since 28 Feb 2024 If set to true, identifies that the git job was created for a manual git deployment", "enum": [ false, true ] }, "commitVerification": { "type": "string", "description": "Since 6 Nov 2025 The verification status of the commit. - 'verified' if the commit is verified - 'unverified' if the commit is not verified - 'unknown' if the commit verification status is unknown or not supported", "enum": [ "verified", "unverified", "unknown" ] }, "nsnbSideEffect": { "type": "object", "description": "Since March 2026 Records a successful NSNB auto-add result so later GitHub PR comments can deterministically explain why this SHA was allowed to deploy.", "required": [ "action", "gitUserLogin" ], "properties": { "action": { "type": "string", "enum": [ "auto-approved-member", "auto-approved-pending-invite" ] }, "gitUserLogin": { "type": "string" } } }, "headInfo": { "type": "object", "description": "Vercel", "required": [ "org", "ref", "repo", "sha" ], "properties": { "org": { "type": "string" }, "ref": { "type": "string" }, "repo": { "type": "string" }, "sha": { "type": "string" } } }, "org": { "type": "string" }, "provider": { "type": "string", "enum": [ "vercel" ] }, "customEnvId": { "type": "string", "nullable": true }, "prId": { "type": "number", "nullable": true } } } ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "url" ], "properties": { "url": { "type": "string" }, "oldTeam": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } }, "newTeam": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "gitCommitterName", "gitUserPlatform", "projectName", "sha", "source" ], "properties": { "sha": { "type": "string" }, "gitUserPlatform": { "type": "string" }, "projectName": { "type": "string" }, "gitCommitterName": { "type": "string" }, "source": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "deployment", "deploymentId", "url" ], "properties": { "deployment": { "type": "object", "required": [ "id", "meta", "name", "url" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "string" } }, "url": { "type": "string" } } }, "deploymentId": { "type": "string" }, "url": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "configurationId", "integrationId", "integrationName", "integrationSlug", "ownerId" ], "properties": { "integrationId": { "type": "string" }, "configurationId": { "type": "string" }, "integrationSlug": { "type": "string" }, "integrationName": { "type": "string" }, "ownerId": { "type": "string" }, "projectIds": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "domain", "id", "name", "type", "value" ], "properties": { "id": { "type": "string" }, "value": { "type": "string" }, "name": { "type": "string" }, "domain": { "type": "string" }, "type": { "type": "string" }, "mxPriority": { "type": "number" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "domain", "id", "name", "type", "value" ], "properties": { "id": { "type": "string" }, "value": { "type": "string" }, "name": { "type": "string" }, "domain": { "type": "string" }, "type": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "name" ], "properties": { "name": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "name", "price" ], "properties": { "name": { "type": "string" }, "price": { "type": "number" }, "currency": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "cdnEnabled", "name" ], "properties": { "name": { "type": "string" }, "cdnEnabled": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "name" ], "properties": { "name": { "type": "string" }, "oldTeam": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } }, "newTeam": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "name", "ownerName", "teamId", "userId" ], "properties": { "name": { "type": "string" }, "userId": { "type": "string" }, "teamId": { "type": "string" }, "ownerName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "domainId", "name" ], "properties": { "domainId": { "type": "string" }, "name": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "id", "name", "nameservers", "previousServiceType", "serviceType" ], "properties": { "previousServiceType": { "type": "string" }, "serviceType": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "nameservers": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "customNameservers", "domain", "prevCustomNameservers" ], "properties": { "domain": { "type": "string" }, "customNameservers": { "type": "array", "nullable": true, "items": { "type": "string" } }, "prevCustomNameservers": { "type": "array", "nullable": true, "items": { "type": "string" } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "domain" ], "properties": { "domain": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "domain", "zone" ], "properties": { "domain": { "type": "string" }, "zone": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "fromId", "fromName", "name" ], "properties": { "name": { "type": "string" }, "fromId": { "type": "string", "nullable": true }, "fromName": { "type": "string", "nullable": true } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "destinationId", "destinationName", "name" ], "properties": { "name": { "type": "string" }, "destinationId": { "type": "string", "nullable": true }, "destinationName": { "type": "string", "nullable": true } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "destinationId", "destinationName", "name" ], "properties": { "name": { "type": "string" }, "destinationId": { "type": "string" }, "destinationName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "domain" ], "properties": { "renew": { "type": "boolean", "enum": [ false, true ] }, "domain": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "name" ], "properties": { "name": { "type": "string" }, "price": { "type": "number" }, "currency": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "drainUrl" ], "properties": { "drainUrl": { "type": "string", "nullable": true }, "integrationName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId", "projectName", "srcImages" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "srcImages": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId", "projectName", "tags" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "target": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "edgeConfigDigest", "edgeConfigId", "edgeConfigSlug" ], "properties": { "edgeConfigId": { "type": "string" }, "edgeConfigSlug": { "type": "string" }, "edgeConfigDigest": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "edgeConfigId", "edgeConfigSlug" ], "properties": { "edgeConfigId": { "type": "string" }, "edgeConfigSlug": { "type": "string" }, "edgeConfigSchema": { "type": "object" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "edgeConfigId", "edgeConfigSlug" ], "properties": { "edgeConfigId": { "type": "string" }, "edgeConfigSlug": { "type": "string" }, "edgeConfigDigest": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "edgeConfig", "fromAccount", "toAccount" ], "properties": { "edgeConfig": { "type": "object", "required": [ "id", "slug" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" } } }, "fromAccount": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "user", "team" ] }, "slug": { "type": "string" }, "username": { "type": "string" } } }, "toAccount": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "user", "team" ] }, "slug": { "type": "string" }, "username": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "edgeConfigId", "edgeConfigSlug", "edgeConfigTokenId", "label" ], "properties": { "edgeConfigId": { "type": "string" }, "edgeConfigSlug": { "type": "string" }, "edgeConfigTokenId": { "type": "string" }, "label": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "edgeConfigId", "edgeConfigSlug", "edgeConfigTokenIds" ], "properties": { "edgeConfigId": { "type": "string" }, "edgeConfigSlug": { "type": "string" }, "edgeConfigTokenIds": { "type": "array", "description": "ids of deleted tokens", "items": { "type": "string" } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "email", "name" ], "properties": { "email": { "type": "string" }, "name": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "previousRule", "team" ], "properties": { "team": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "previousRule": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "team" ], "properties": { "team": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "previousRule": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string" } } }, "nextRule": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "key": { "type": "string" }, "projectId": { "type": "string" }, "projectName": { "type": "string" }, "target": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "customEnvironmentSlugs": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "gitBranch": { "type": "string" }, "edgeConfigId": { "type": "string", "nullable": true }, "edgeConfigTokenId": { "type": "string", "nullable": true }, "source": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "created": { "type": "string", "description": "The date when the Shared Env Var was created.", "format": "date-time" }, "key": { "type": "string", "description": "The name of the Shared Env Var." }, "ownerId": { "type": "string", "description": "The unique identifier of the owner (team) the Shared Env Var was created for.", "nullable": true }, "id": { "type": "string", "description": "The unique identifier of the Shared Env Var." }, "createdBy": { "type": "string", "description": "The unique identifier of the user who created the Shared Env Var.", "nullable": true }, "deletedBy": { "type": "string", "description": "The unique identifier of the user who deleted the Shared Env Var.", "nullable": true }, "updatedBy": { "type": "string", "description": "The unique identifier of the user who last updated the Shared Env Var.", "nullable": true }, "createdAt": { "type": "number", "description": "Timestamp for when the Shared Env Var was created." }, "deletedAt": { "type": "number", "description": "Timestamp for when the Shared Env Var was (soft) deleted." }, "updatedAt": { "type": "number", "description": "Timestamp for when the Shared Env Var was last updated." }, "value": { "type": "string", "description": "The value of the Shared Env Var." }, "projectId": { "type": "array", "description": "The unique identifiers of the projects which the Shared Env Var is linked to.", "items": { "type": "string" } }, "type": { "type": "string", "description": "The type of this cosmos doc instance, if blank, assume secret.", "enum": [ "system", "encrypted", "plain", "sensitive" ] }, "target": { "type": "array", "description": "environments this env variable targets", "items": { "type": "string", "description": "environments this env variable targets", "enum": [ "production", "preview", "development" ] } }, "applyToAllCustomEnvironments": { "type": "boolean", "description": "whether or not this env varible applies to custom environments", "enum": [ false, true ] }, "decrypted": { "type": "boolean", "description": "whether or not this env variable is decrypted", "enum": [ false, true ] }, "comment": { "type": "string", "description": "A user provided comment that describes what this Shared Env Var is for." }, "lastEditedByDisplayName": { "type": "string", "description": "The last editor full name or username." }, "projectNames": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "oldEnvVar": { "type": "object", "properties": { "created": { "type": "string", "description": "The date when the Shared Env Var was created.", "format": "date-time" }, "key": { "type": "string", "description": "The name of the Shared Env Var." }, "ownerId": { "type": "string", "description": "The unique identifier of the owner (team) the Shared Env Var was created for.", "nullable": true }, "id": { "type": "string", "description": "The unique identifier of the Shared Env Var." }, "createdBy": { "type": "string", "description": "The unique identifier of the user who created the Shared Env Var.", "nullable": true }, "deletedBy": { "type": "string", "description": "The unique identifier of the user who deleted the Shared Env Var.", "nullable": true }, "updatedBy": { "type": "string", "description": "The unique identifier of the user who last updated the Shared Env Var.", "nullable": true }, "createdAt": { "type": "number", "description": "Timestamp for when the Shared Env Var was created." }, "deletedAt": { "type": "number", "description": "Timestamp for when the Shared Env Var was (soft) deleted." }, "updatedAt": { "type": "number", "description": "Timestamp for when the Shared Env Var was last updated." }, "value": { "type": "string", "description": "The value of the Shared Env Var." }, "projectId": { "type": "array", "description": "The unique identifiers of the projects which the Shared Env Var is linked to.", "items": { "type": "string" } }, "type": { "type": "string", "description": "The type of this cosmos doc instance, if blank, assume secret.", "enum": [ "system", "encrypted", "plain", "sensitive" ] }, "target": { "type": "array", "description": "environments this env variable targets", "items": { "type": "string", "description": "environments this env variable targets", "enum": [ "production", "preview", "development" ] } }, "applyToAllCustomEnvironments": { "type": "boolean", "description": "whether or not this env varible applies to custom environments", "enum": [ false, true ] }, "decrypted": { "type": "boolean", "description": "whether or not this env variable is decrypted", "enum": [ false, true ] }, "comment": { "type": "string", "description": "A user provided comment that describes what this Shared Env Var is for." }, "lastEditedByDisplayName": { "type": "string", "description": "The last editor full name or username." } } }, "newEnvVar": { "type": "object", "properties": { "created": { "type": "string", "description": "The date when the Shared Env Var was created.", "format": "date-time" }, "key": { "type": "string", "description": "The name of the Shared Env Var." }, "ownerId": { "type": "string", "description": "The unique identifier of the owner (team) the Shared Env Var was created for.", "nullable": true }, "id": { "type": "string", "description": "The unique identifier of the Shared Env Var." }, "createdBy": { "type": "string", "description": "The unique identifier of the user who created the Shared Env Var.", "nullable": true }, "deletedBy": { "type": "string", "description": "The unique identifier of the user who deleted the Shared Env Var.", "nullable": true }, "updatedBy": { "type": "string", "description": "The unique identifier of the user who last updated the Shared Env Var.", "nullable": true }, "createdAt": { "type": "number", "description": "Timestamp for when the Shared Env Var was created." }, "deletedAt": { "type": "number", "description": "Timestamp for when the Shared Env Var was (soft) deleted." }, "updatedAt": { "type": "number", "description": "Timestamp for when the Shared Env Var was last updated." }, "value": { "type": "string", "description": "The value of the Shared Env Var." }, "projectId": { "type": "array", "description": "The unique identifiers of the projects which the Shared Env Var is linked to.", "items": { "type": "string" } }, "type": { "type": "string", "description": "The type of this cosmos doc instance, if blank, assume secret.", "enum": [ "system", "encrypted", "plain", "sensitive" ] }, "target": { "type": "array", "description": "environments this env variable targets", "items": { "type": "string", "description": "environments this env variable targets", "enum": [ "production", "preview", "development" ] } }, "applyToAllCustomEnvironments": { "type": "boolean", "description": "whether or not this env varible applies to custom environments", "enum": [ false, true ] }, "decrypted": { "type": "boolean", "description": "whether or not this env variable is decrypted", "enum": [ false, true ] }, "comment": { "type": "string", "description": "A user provided comment that describes what this Shared Env Var is for." }, "lastEditedByDisplayName": { "type": "string", "description": "The last editor full name or username." } } }, "updateDiff": { "type": "object", "required": [ "changedValue", "id" ], "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "newKey": { "type": "string" }, "oldTarget": { "type": "array", "items": { "type": "string", "enum": [ "production", "preview", "development" ] } }, "newTarget": { "type": "array", "items": { "type": "string", "enum": [ "production", "preview", "development" ] } }, "oldType": { "type": "string" }, "newType": { "type": "string" }, "oldProjects": { "type": "array", "items": { "type": "object", "required": [ "projectId" ], "properties": { "projectName": { "type": "string" }, "projectId": { "type": "string" } } } }, "newProjects": { "type": "array", "items": { "type": "object", "required": [ "projectId" ], "properties": { "projectName": { "type": "string" }, "projectId": { "type": "string" } } } }, "changedValue": { "type": "boolean", "enum": [ false, true ] } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId", "scope", "source" ], "properties": { "projectId": { "type": "string" }, "scope": { "type": "string" }, "source": { "type": "string" }, "expiresAt": { "type": "number", "nullable": true } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId", "scope", "source" ], "properties": { "projectId": { "type": "string" }, "scope": { "type": "string" }, "source": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "configVersion", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "configVersion": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "configChangeCount", "configChanges", "configVersion", "projectId", "restore" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "restore": { "type": "boolean", "enum": [ false, true ] }, "configVersion": { "type": "number" }, "configChangeCount": { "type": "number" }, "configChanges": { "type": "array", "items": { "type": "object" } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId", "ruleGroups", "rulesetName" ], "properties": { "projectId": { "type": "string" }, "rulesetName": { "type": "string" }, "ruleGroups": { "type": "object", "additionalProperties": { "type": "object", "required": [ "active" ], "properties": { "active": { "type": "boolean", "enum": [ false, true ] }, "action": { "type": "string", "enum": [ "log", "challenge", "deny" ] } } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "active", "projectId", "rulesetName" ], "properties": { "projectId": { "type": "string" }, "rulesetName": { "type": "string" }, "active": { "type": "boolean", "enum": [ false, true ] }, "action": { "type": "string", "enum": [ "log", "challenge", "deny" ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "action" ], "properties": { "action": { "type": "string", "enum": [ "enable", "disable" ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "fromDeploymentId", "projectId", "projectName", "toDeploymentId" ], "properties": { "projectId": { "type": "string" }, "fromDeploymentId": { "type": "string" }, "toDeploymentId": { "type": "string" }, "projectName": { "type": "string" }, "reason": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "configurationId", "integrationId", "integrationSlug", "newOwner", "userId" ], "properties": { "userId": { "type": "string" }, "integrationId": { "type": "string" }, "configurationId": { "type": "string" }, "integrationSlug": { "type": "string" }, "integrationName": { "type": "string" }, "newOwner": { "type": "object", "nullable": true, "required": [ "billing", "blocked", "createdAt", "deploymentSecret", "email", "id", "platformVersion", "stagingPrefix", "sysToken", "type", "updatedAt", "username", "version" ], "properties": { "abuse": { "type": "object", "required": [ "updatedAt" ], "properties": { "blockHistory": { "type": "array", "description": "Since June 2023", "items": { "type": "object", "description": "Since June 2023", "required": [ "action", "createdAt", "reason" ], "properties": { "action": { "type": "string", "enum": [ "blocked", "hard-blocked", "soft-blocked", "unblocked" ] }, "createdAt": { "type": "number" }, "caseId": { "type": "string" }, "reason": { "type": "string" }, "actor": { "type": "string" }, "statusCode": { "type": "number" }, "comment": { "type": "string" }, "ineligibleForAppeal": { "type": "boolean", "enum": [ false, true ] } } } }, "gitAuthHistory": { "type": "array", "description": "Since March 2022. Helps abuse checks by tracking git auths. Format: `::`", "items": { "type": "string" } }, "history": { "type": "array", "description": "(scanner history). Since November 2021. First element is newest.", "items": { "type": "object", "description": "(scanner history). Since November 2021. First element is newest.", "required": [ "at", "by", "byId", "reason", "scanner" ], "properties": { "scanner": { "type": "string" }, "reason": { "type": "string" }, "by": { "type": "string" }, "byId": { "type": "string" }, "at": { "type": "number" } } } }, "gitLineageBlocks": { "type": "number", "description": "Since September 2023. How often did this owner trigger an actual git lineage deploy block?" }, "gitLineageBlocksDry": { "type": "number", "description": "Since September 2023. How often did this owner trigger a git lineage deploy block dry run?" }, "scanner": { "type": "string", "description": "Since November 2021. Guides the abuse scanner in build container." }, "scheduledUnblockAt": { "type": "string", "description": "Since December 2025. UTC timestamp string of when an auto-unblock is scheduled. Format: \"Wed, 03 Dec 2025 20:32:13 GMT\"" }, "updatedAt": { "type": "number", "description": "Since November 2021" }, "creationUserAgent": { "type": "string" }, "creationIp": { "type": "string" }, "removedPhoneNumbers": { "type": "string" } } }, "acceptanceState": { "type": "string" }, "acceptedAt": { "type": "number" }, "avatar": { "type": "string" }, "billing": { "type": "object", "required": [ "plan" ], "properties": { "plan": { "type": "string", "enum": [ "pro", "enterprise", "hobby" ] } } }, "blocked": { "type": "number", "nullable": true }, "blockReason": { "type": "string" }, "created": { "type": "number" }, "createdAt": { "type": "number" }, "credentials": { "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "id", "type" ], "properties": { "type": { "type": "string", "enum": [ "vercel", "gitlab", "bitbucket", "google", "apple", "chatgpt", "github-oauth", "github-oauth-limited" ] }, "id": { "type": "string" } } }, { "type": "object", "required": [ "host", "id", "type" ], "properties": { "type": { "type": "string", "enum": [ "github-oauth-custom-host" ] }, "host": { "type": "string" }, "id": { "type": "string" } } } ] } }, "customerId": { "type": "string", "nullable": true }, "orbCustomerId": { "type": "string", "nullable": true }, "dataCache": { "type": "object", "properties": { "excessBillingEnabled": { "type": "boolean", "enum": [ false, true ] } } }, "deletedAt": { "type": "number", "nullable": true }, "deploymentSecret": { "type": "string" }, "dismissedTeams": { "type": "array", "items": { "type": "string" } }, "dismissedToasts": { "type": "array", "items": { "type": "object", "required": [ "dismissals", "name" ], "properties": { "name": { "type": "string" }, "dismissals": { "type": "array", "items": { "type": "object", "required": [ "createdAt", "scopeId" ], "properties": { "scopeId": { "type": "string" }, "createdAt": { "type": "number" } } } } } } }, "favoriteProjectsAndSpaces": { "type": "array", "items": { "type": "object", "required": [ "projectId", "teamId" ], "properties": { "teamId": { "type": "string" }, "projectId": { "type": "string" } } } }, "email": { "type": "string" }, "id": { "type": "string" }, "importFlowGitNamespace": { "nullable": true, "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "importFlowGitNamespaceId": { "nullable": true, "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "importFlowGitProvider": { "type": "string", "enum": [ "vercel", "github", "github-limited", "github-custom-host", "gitlab", "bitbucket" ], "nullable": true }, "preferredScopesAndGitNamespaces": { "type": "array", "items": { "type": "object", "required": [ "gitNamespaceId", "scopeId" ], "properties": { "scopeId": { "type": "string" }, "gitNamespaceId": { "nullable": true, "oneOf": [ { "type": "string" }, { "type": "number" } ] } } } }, "isDomainReseller": { "type": "boolean", "enum": [ false, true ] }, "isZeitPub": { "type": "boolean", "enum": [ false, true ] }, "testAccountExpiresAt": { "type": "number" }, "maxActiveSlots": { "type": "number" }, "name": { "type": "string" }, "phoneNumber": { "type": "string" }, "platformVersion": { "type": "number", "nullable": true }, "preventAutoBlocking": { "oneOf": [ { "type": "number" }, { "type": "boolean", "enum": [ false, true ] } ] }, "projectDomainsLimit": { "type": "number", "description": "Overrides our DEFAULT project domains limit per account or per project." }, "remoteCaching": { "type": "object", "description": "Represents configuration for remote caching", "properties": { "enabled": { "type": "boolean", "enum": [ false, true ] } } }, "removedAliasesAt": { "type": "number" }, "removedBillingSubscriptionAt": { "type": "number" }, "removedConfigurationsAt": { "type": "number" }, "removedDeploymentsAt": { "type": "number" }, "removedDomiansAt": { "type": "number" }, "removedEventsAt": { "type": "number" }, "removedProjectsAt": { "type": "number" }, "removedSecretsAt": { "type": "number" }, "removedSharedEnvVarsAt": { "type": "number" }, "removedEdgeConfigsAt": { "type": "number" }, "resourceConfig": { "type": "object", "properties": { "nodeType": { "type": "string" }, "concurrentBuilds": { "type": "number" }, "elasticConcurrencyEnabled": { "type": "boolean", "enum": [ false, true ] }, "buildEntitlements": { "type": "object", "properties": { "enhancedBuilds": { "type": "boolean", "enum": [ false, true ] } } }, "buildQueue": { "type": "object", "properties": { "configuration": { "type": "string", "enum": [ "SKIP_NAMESPACE_QUEUE", "WAIT_FOR_NAMESPACE_QUEUE" ] } } }, "awsAccountType": { "type": "string" }, "awsAccountIds": { "type": "array", "items": { "type": "string" } }, "cfZoneName": { "type": "string" }, "imageOptimizationType": { "type": "string" }, "edgeConfigs": { "type": "number" }, "edgeConfigSize": { "type": "number" }, "edgeFunctionMaxSizeBytes": { "type": "number" }, "edgeFunctionExecutionTimeoutMs": { "type": "number" }, "serverlessFunctionMaxMemorySize": { "type": "number" }, "kvDatabases": { "type": "number" }, "postgresDatabases": { "type": "number" }, "blobStores": { "type": "number" }, "integrationStores": { "type": "number" }, "cronJobsPerProject": { "type": "number" }, "microfrontendGroupsPerTeam": { "type": "number" }, "microfrontendProjectsPerGroup": { "type": "number" }, "flagsExplorerOverridesThreshold": { "type": "number" }, "flagsExplorerUnlimitedOverrides": { "type": "boolean", "enum": [ false, true ] }, "customEnvironmentsPerProject": { "type": "number" }, "buildMachine": { "type": "object", "properties": { "default": { "type": "string", "enum": [ "enhanced", "turbo", "standard", "elastic" ] }, "purchaseType": { "type": "string", "enum": [ "enhanced", "turbo", "standard" ] }, "defaultPurchaseType": { "type": "string", "enum": [ "enhanced", "turbo", "standard" ] }, "cores": { "type": "number" }, "memory": { "type": "number" }, "machineSelectionType": { "type": "string", "enum": [ "fixed", "elastic" ] } } }, "security": { "type": "object", "properties": { "customRules": { "type": "number" }, "ipBlocks": { "type": "number" }, "ipBypass": { "type": "number" }, "rateLimit": { "type": "number" } } }, "bulkRedirectsFreeLimitOverride": { "type": "number" } } }, "resourceLimits": { "type": "object", "description": "User | Team resource limits", "additionalProperties": { "type": "object", "required": [ "duration", "max" ], "properties": { "max": { "type": "number" }, "duration": { "type": "number" } } } }, "activeDashboardViews": { "type": "array", "items": { "type": "object", "required": [ "scopeId" ], "properties": { "scopeId": { "type": "string" }, "viewPreference": { "type": "string", "enum": [ "list", "cards" ], "nullable": true }, "favoritesViewPreference": { "type": "string", "enum": [ "open", "closed" ], "nullable": true }, "recentsViewPreference": { "type": "string", "enum": [ "open", "closed" ], "nullable": true } } } }, "secondaryEmails": { "type": "array", "items": { "type": "object", "required": [ "email", "verified" ], "properties": { "email": { "type": "string" }, "verified": { "type": "boolean", "enum": [ false, true ] } } } }, "emailDomains": { "type": "array", "items": { "type": "string" } }, "emailNotifications": { "type": "object", "properties": { "rules": { "type": "object", "additionalProperties": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string" } } } } } }, "siftScore": { "type": "number" }, "siftScores": { "type": "object", "additionalProperties": { "type": "object", "required": [ "reasons", "score" ], "properties": { "score": { "type": "number" }, "reasons": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } }, "siftRoute": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "enum": [ "string" ] } } }, "sfdcId": { "type": "string" }, "softBlock": { "type": "object", "nullable": true, "required": [ "blockedAt", "reason" ], "properties": { "blockedAt": { "type": "number" }, "reason": { "type": "string", "enum": [ "SUBSCRIPTION_CANCELED", "SUBSCRIPTION_EXPIRED", "UNPAID_INVOICE", "ENTERPRISE_TRIAL_ENDED", "FAIR_USE_LIMITS_EXCEEDED", "BLOCKED_FOR_PLATFORM_ABUSE" ] }, "blockedDueToOverageType": { "type": "string", "enum": [ "analyticsUsage", "artifacts", "bandwidth", "blobTotalAdvancedRequests", "blobTotalAvgSizeInBytes", "blobTotalGetResponseObjectSizeInBytes", "blobTotalSimpleRequests", "connectDataTransfer", "dataCacheRead", "dataCacheWrite", "edgeConfigRead", "edgeConfigWrite", "edgeFunctionExecutionUnits", "edgeMiddlewareInvocations", "edgeRequestAdditionalCpuDuration", "edgeRequest", "elasticConcurrencyBuildSlots", "fastDataTransfer", "fastOriginTransfer", "fluidCpuDuration", "fluidDuration", "functionDuration", "functionInvocation", "imageOptimizationCacheRead", "imageOptimizationCacheWrite", "imageOptimizationTransformation", "logDrainsVolume", "monitoringMetric", "blobDataTransfer", "observabilityEvent", "onDemandConcurrencyMinutes", "runtimeCacheRead", "runtimeCacheWrite", "serverlessFunctionExecution", "sourceImages", "wafOwaspExcessBytes", "wafOwaspRequests", "wafRateLimitRequest", "webAnalyticsEvent" ] } } }, "stagingPrefix": { "type": "string" }, "sysToken": { "type": "string" }, "teams": { "type": "array", "description": "A helper that allows to describe a relationship attribute. It receives the shape of a relationship plus the foreignKey name to make it mandatory in the resulting type.", "items": { "type": "object", "required": [ "confirmed", "confirmedAt", "created", "createdAt", "role", "teamId" ], "properties": { "createdAt": { "type": "number" }, "teamId": { "type": "string" }, "confirmed": { "type": "boolean", "enum": [ true ] }, "confirmedAt": { "type": "number" }, "accessRequestedAt": { "type": "number" }, "role": { "type": "string", "enum": [ "OWNER", "MEMBER", "DEVELOPER", "SECURITY", "BILLING", "VIEWER", "VIEWER_FOR_PLUS", "CONTRIBUTOR" ] }, "teamRoles": { "type": "array", "items": { "type": "string", "enum": [ "OWNER", "MEMBER", "DEVELOPER", "SECURITY", "BILLING", "VIEWER", "VIEWER_FOR_PLUS", "CONTRIBUTOR" ] } }, "teamPermissions": { "type": "array", "items": { "type": "string", "enum": [ "IntegrationManager", "CreateProject", "FullProductionDeployment", "UsageViewer", "EnvVariableManager", "EnvironmentManager", "V0Builder", "V0Chatter", "V0Viewer" ] } }, "created": { "type": "number" }, "joinedFrom": { "type": "object", "required": [ "origin" ], "properties": { "origin": { "type": "string", "enum": [ "link", "import", "teams", "saml", "github", "gitlab", "bitbucket", "mail", "dsync", "feedback", "organization-teams", "nsnb-auto-approve", "nsnb-hobby-upgrade", "nsnb-request-access", "nsnb-viewer-upgrade", "nsnb-invite", "nsnb-redeploy" ] }, "commitId": { "type": "string" }, "repoId": { "type": "string" }, "repoPath": { "type": "string" }, "gitUserId": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "gitUserLogin": { "type": "string" }, "ssoUserId": { "type": "string" }, "ssoConnectedAt": { "type": "number" }, "idpUserId": { "type": "string" }, "dsyncUserId": { "type": "string" }, "dsyncConnectedAt": { "type": "number" } } } } } }, "trialTeamIds": { "type": "array", "description": "Introduced 2022-04-12 An array of teamIds (for trial teams created after 2022-04-01), created by the user in question. Used in determining whether the team has a trial available in utils/api-teams/user-has-trial-available.ts.", "items": { "type": "string" } }, "maxTrials": { "type": "number", "description": "Introduced 2022-04-19 Number of maximum trials to allocate to a user. When undefined, defaults to MAX_TRIALS in utils/api-teams/user-has-trial-available.ts. This is set to trialTeamIds + 1 by services/api-backoffice/src/handlers/add-additional-trial.ts." }, "trialTeamId": { "type": "string", "description": "Deprecated on 2022-04-12 in favor of trialTeamIds and using utils/api-teams/user-has-trial-available.ts." }, "type": { "type": "string", "enum": [ "user" ] }, "usageAlerts": { "type": "object", "description": "Contains the timestamps when a user was notified about their usage", "nullable": true, "properties": { "warningAt": { "type": "number", "nullable": true }, "blockingAt": { "type": "number", "nullable": true } } }, "overageUsageAlerts": { "type": "object", "properties": { "analyticsUsage": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "artifacts": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "bandwidth": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "blobTotalAdvancedRequests": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "blobTotalAvgSizeInBytes": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "blobTotalGetResponseObjectSizeInBytes": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "blobTotalSimpleRequests": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "connectDataTransfer": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "dataCacheRead": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "dataCacheWrite": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "edgeConfigRead": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "edgeConfigWrite": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "edgeFunctionExecutionUnits": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "edgeMiddlewareInvocations": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "edgeRequestAdditionalCpuDuration": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "edgeRequest": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "elasticConcurrencyBuildSlots": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "fastDataTransfer": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "fastOriginTransfer": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "fluidCpuDuration": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "fluidDuration": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "functionDuration": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "functionInvocation": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "imageOptimizationCacheRead": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "imageOptimizationCacheWrite": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "imageOptimizationTransformation": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "logDrainsVolume": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "monitoringMetric": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "blobDataTransfer": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "observabilityEvent": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "onDemandConcurrencyMinutes": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "runtimeCacheRead": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "runtimeCacheWrite": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "serverlessFunctionExecution": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "sourceImages": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "wafOwaspExcessBytes": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "wafOwaspRequests": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "wafRateLimitRequest": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } }, "webAnalyticsEvent": { "type": "object", "required": [ "currentThreshold" ], "properties": { "currentThreshold": { "type": "number" }, "warningAt": { "type": "number", "nullable": true }, "blockedAt": { "type": "number", "nullable": true } } } } }, "overageMetadata": { "type": "object", "description": "Contains the timestamps for usage summary emails.", "properties": { "firstTimeOnDemandNotificationSentAt": { "type": "number", "description": "Tracks if the first time on-demand overage email has been sent." }, "dailyOverageSummaryEmailSentAt": { "type": "number", "description": "Tracks the last time we sent a daily summary email." }, "weeklyOverageSummaryEmailSentAt": { "type": "number", "description": "Tracks the last time we sent a weekly summary email." }, "overageSummaryExpiresAt": { "type": "number", "description": "Tracks when the overage summary email will stop auto-sending. We currently lock the user into email for a month after the last on-demand usage." }, "increasedOnDemandEmailSentAt": { "type": "number", "description": "Tracks the last time we sent a increased on-demand email." }, "increasedOnDemandEmailAttemptedAt": { "type": "number", "description": "Tracks the last time we attempted to send an increased on-demand email. This check is to limit the number of attempts per day." } } }, "username": { "type": "string" }, "updatedAt": { "type": "number" }, "enablePreviewFeedback": { "type": "string", "description": "Whether the Vercel Toolbar is enabled for preview deployments.", "enum": [ "default", "on", "off", "on-force", "off-force", "default-force" ] }, "featureBlocks": { "type": "object", "description": "Information about which features are blocked for a user. Blocks can be either soft (the user can still access the feature, but with a warning, e.g. prompting an upgrade) or hard (the user cannot access the feature at all).", "properties": { "webAnalytics": { "type": "object", "required": [ "blockReason", "updatedAt" ], "properties": { "updatedAt": { "type": "number" }, "blockedFrom": { "type": "number" }, "blockedUntil": { "type": "number" }, "blockReason": { "type": "string", "enum": [ "admin_override", "limits_exceeded", "hard_blocked" ] }, "graceEmailSentAt": { "type": "number" } } }, "monitoring": { "type": "object", "description": "A soft block indicates a temporary pause in data collection (ex limit exceeded for the current cycle) A hard block indicates a stoppage in data collection that requires manual intervention (ex upgrading a pro trial)", "required": [ "blockReason", "blockType", "updatedAt" ], "properties": { "updatedAt": { "type": "number" }, "blockedFrom": { "type": "number" }, "blockedUntil": { "type": "number" }, "blockReason": { "type": "string", "enum": [ "admin_override", "limits_exceeded", "hard_blocked" ] }, "blockType": { "type": "string", "enum": [ "soft", "hard" ] } } }, "observabilityPlus": { "type": "object", "required": [ "blockReason", "blockType", "updatedAt" ], "properties": { "updatedAt": { "type": "number" }, "blockedFrom": { "type": "number" }, "blockedUntil": { "type": "number" }, "blockReason": { "type": "string", "enum": [ "admin_override", "limits_exceeded", "hard_blocked" ] }, "blockType": { "type": "string", "enum": [ "soft", "hard" ] } } }, "dataCache": { "type": "object", "required": [ "blockReason", "updatedAt" ], "properties": { "updatedAt": { "type": "number" }, "blockedFrom": { "type": "number" }, "blockedUntil": { "type": "number" }, "blockReason": { "type": "string", "enum": [ "admin_override", "limits_exceeded", "hard_blocked" ] } } }, "imageOptimizationTransformation": { "type": "object", "required": [ "blockReason", "updatedAt" ], "properties": { "updatedAt": { "type": "number" }, "blockedFrom": { "type": "number" }, "blockedUntil": { "type": "number" }, "blockReason": { "type": "string", "enum": [ "admin_override", "limits_exceeded", "hard_blocked" ] } } }, "sourceImages": { "type": "object", "required": [ "blockReason", "updatedAt" ], "properties": { "updatedAt": { "type": "number" }, "blockedFrom": { "type": "number" }, "blockedUntil": { "type": "number" }, "blockReason": { "type": "string", "enum": [ "admin_override", "limits_exceeded", "hard_blocked" ] } } }, "blob": { "oneOf": [ { "type": "object", "required": [ "blockReason", "overageReason", "updatedAt" ], "properties": { "updatedAt": { "type": "number" }, "blockedFrom": { "type": "number" }, "blockedUntil": { "type": "number" }, "blockReason": { "type": "string", "enum": [ "limits_exceeded" ] }, "overageReason": { "type": "string", "enum": [ "analyticsUsage", "artifacts", "bandwidth", "blobTotalAdvancedRequests", "blobTotalAvgSizeInBytes", "blobTotalGetResponseObjectSizeInBytes", "blobTotalSimpleRequests", "connectDataTransfer", "dataCacheRead", "dataCacheWrite", "edgeConfigRead", "edgeConfigWrite", "edgeFunctionExecutionUnits", "edgeMiddlewareInvocations", "edgeRequestAdditionalCpuDuration", "edgeRequest", "elasticConcurrencyBuildSlots", "fastDataTransfer", "fastOriginTransfer", "fluidCpuDuration", "fluidDuration", "functionDuration", "functionInvocation", "imageOptimizationCacheRead", "imageOptimizationCacheWrite", "imageOptimizationTransformation", "logDrainsVolume", "monitoringMetric", "blobDataTransfer", "observabilityEvent", "onDemandConcurrencyMinutes", "runtimeCacheRead", "runtimeCacheWrite", "serverlessFunctionExecution", "sourceImages", "wafOwaspExcessBytes", "wafOwaspRequests", "wafRateLimitRequest", "webAnalyticsEvent" ] } } }, { "type": "object", "required": [ "blockReason", "updatedAt" ], "properties": { "updatedAt": { "type": "number" }, "blockedFrom": { "type": "number" }, "blockedUntil": { "type": "number" }, "blockReason": { "type": "string", "enum": [ "admin_override", "hard_blocked" ] } } } ] }, "postgres": { "oneOf": [ { "type": "object", "required": [ "blockReason", "overageReason", "updatedAt" ], "properties": { "updatedAt": { "type": "number" }, "blockedFrom": { "type": "number" }, "blockedUntil": { "type": "number" }, "blockReason": { "type": "string", "enum": [ "limits_exceeded" ] }, "overageReason": { "type": "string", "enum": [ "analyticsUsage", "artifacts", "bandwidth", "blobTotalAdvancedRequests", "blobTotalAvgSizeInBytes", "blobTotalGetResponseObjectSizeInBytes", "blobTotalSimpleRequests", "connectDataTransfer", "dataCacheRead", "dataCacheWrite", "edgeConfigRead", "edgeConfigWrite", "edgeFunctionExecutionUnits", "edgeMiddlewareInvocations", "edgeRequestAdditionalCpuDuration", "edgeRequest", "elasticConcurrencyBuildSlots", "fastDataTransfer", "fastOriginTransfer", "fluidCpuDuration", "fluidDuration", "functionDuration", "functionInvocation", "imageOptimizationCacheRead", "imageOptimizationCacheWrite", "imageOptimizationTransformation", "logDrainsVolume", "monitoringMetric", "blobDataTransfer", "observabilityEvent", "onDemandConcurrencyMinutes", "runtimeCacheRead", "runtimeCacheWrite", "serverlessFunctionExecution", "sourceImages", "wafOwaspExcessBytes", "wafOwaspRequests", "wafRateLimitRequest", "webAnalyticsEvent" ] } } }, { "type": "object", "required": [ "blockReason", "updatedAt" ], "properties": { "updatedAt": { "type": "number" }, "blockedFrom": { "type": "number" }, "blockedUntil": { "type": "number" }, "blockReason": { "type": "string", "enum": [ "admin_override", "hard_blocked" ] } } } ] }, "redis": { "oneOf": [ { "type": "object", "required": [ "blockReason", "overageReason", "updatedAt" ], "properties": { "updatedAt": { "type": "number" }, "blockedFrom": { "type": "number" }, "blockedUntil": { "type": "number" }, "blockReason": { "type": "string", "enum": [ "limits_exceeded" ] }, "overageReason": { "type": "string", "enum": [ "analyticsUsage", "artifacts", "bandwidth", "blobTotalAdvancedRequests", "blobTotalAvgSizeInBytes", "blobTotalGetResponseObjectSizeInBytes", "blobTotalSimpleRequests", "connectDataTransfer", "dataCacheRead", "dataCacheWrite", "edgeConfigRead", "edgeConfigWrite", "edgeFunctionExecutionUnits", "edgeMiddlewareInvocations", "edgeRequestAdditionalCpuDuration", "edgeRequest", "elasticConcurrencyBuildSlots", "fastDataTransfer", "fastOriginTransfer", "fluidCpuDuration", "fluidDuration", "functionDuration", "functionInvocation", "imageOptimizationCacheRead", "imageOptimizationCacheWrite", "imageOptimizationTransformation", "logDrainsVolume", "monitoringMetric", "blobDataTransfer", "observabilityEvent", "onDemandConcurrencyMinutes", "runtimeCacheRead", "runtimeCacheWrite", "serverlessFunctionExecution", "sourceImages", "wafOwaspExcessBytes", "wafOwaspRequests", "wafRateLimitRequest", "webAnalyticsEvent" ] } } }, { "type": "object", "required": [ "blockReason", "updatedAt" ], "properties": { "updatedAt": { "type": "number" }, "blockedFrom": { "type": "number" }, "blockedUntil": { "type": "number" }, "blockReason": { "type": "string", "enum": [ "admin_override", "hard_blocked" ] } } } ] }, "microfrontendsRequest": { "type": "object", "required": [ "blockReason", "updatedAt" ], "properties": { "updatedAt": { "type": "number" }, "blockedFrom": { "type": "number" }, "blockedUntil": { "type": "number" }, "blockReason": { "type": "string", "enum": [ "admin_override", "limits_exceeded", "hard_blocked" ] } } }, "workflowStorage": { "type": "object", "required": [ "blockReason", "updatedAt" ], "properties": { "updatedAt": { "type": "number" }, "blockedFrom": { "type": "number" }, "blockedUntil": { "type": "number" }, "blockReason": { "type": "string", "enum": [ "admin_override", "limits_exceeded", "hard_blocked" ] } } }, "workflowStep": { "type": "object", "required": [ "blockReason", "updatedAt" ], "properties": { "updatedAt": { "type": "number" }, "blockedFrom": { "type": "number" }, "blockedUntil": { "type": "number" }, "blockReason": { "type": "string", "enum": [ "admin_override", "limits_exceeded", "hard_blocked" ] } } } } }, "defaultTeamId": { "type": "string" }, "version": { "type": "string", "enum": [ "northstar" ] }, "northstarMigration": { "type": "object", "description": "An archive of information about the Northstar migration, derived from the old (deprecated) property, `northstarMigrationEvents`.", "required": [ "endTime", "integrationClients", "integrationConfigurations", "projects", "startTime", "stores", "teamId" ], "properties": { "teamId": { "type": "string", "description": "The ID of the team we created for this user." }, "projects": { "type": "number", "description": "The number of projects migrated for this user." }, "stores": { "type": "number", "description": "The number of stores migrated for this user." }, "integrationConfigurations": { "type": "number", "description": "The number of integration configurations migrated for this user." }, "integrationClients": { "type": "number", "description": "The number of integration clients migrated for this user." }, "startTime": { "type": "number", "description": "The migration start time timestamp for this user." }, "endTime": { "type": "number", "description": "The migration end time timestamp for this user." } } }, "opportunityId": { "type": "string", "description": "The salesforce opportunity ID that this user is linked to. This is used to automatically associate a team of the user's choosing with the opportunity." }, "mfaConfiguration": { "type": "object", "description": "MFA configuration. When enabled, the user will be required to provide a second factor of authentication when logging in.", "required": [ "enabled", "recoveryCodes" ], "properties": { "enabled": { "type": "boolean", "enum": [ false, true ] }, "enabledAt": { "type": "number" }, "recoveryCodes": { "type": "array", "items": { "type": "string" } }, "totp": { "type": "object", "required": [ "createdAt", "secret" ], "properties": { "secret": { "type": "string" }, "createdAt": { "type": "number" } } }, "history": { "type": "array", "description": "History of MFA state changes (enabled/disabled events). Most recent events first.", "items": { "type": "object", "description": "History of MFA state changes (enabled/disabled events). Most recent events first.", "required": [ "action", "actorId", "actorType", "method", "timestamp" ], "properties": { "action": { "type": "string", "description": "The action that occurred", "enum": [ "enabled", "disabled" ] }, "timestamp": { "type": "number", "description": "Unix timestamp (milliseconds) when the change occurred. May be null for events that occurred before history tracking was implemented.", "nullable": true }, "method": { "type": "string", "description": "Method used for the state change - 'totp': User set up TOTP authenticator - 'passkey': User registered a passkey - 'user_disabled': User disabled their own MFA - 'admin_removal': Admin removed MFA via backoffice - 'unknown': Method unknown (for pre-tracking events)", "enum": [ "totp", "passkey", "unknown", "user_disabled", "admin_removal" ] }, "actorId": { "type": "string", "description": "ID of the actor who made the change - For user actions: the user's own ID - For admin actions: the admin's user ID" }, "actorType": { "type": "string", "description": "Type of actor", "enum": [ "user", "admin" ] }, "reason": { "type": "string", "description": "Optional: Additional context or reason e.g., \"Account recovery request - ticket #12345\"" } } } } } }, "isEnterpriseManaged": { "type": "boolean", "description": "Indicates that the underlying user entity is a managed user for the enterprise it's associated with The intention is that this field is only set to true for users that are provisioned by the enterprise which means that the domain associated with the user's email is the same domain associated with the team Allowing us to query information about the user's team at login time through the domain verification service", "enum": [ false, true ] } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "configurationId", "confirmedScopes", "integrationId", "integrationName", "integrationSlug", "ownerId" ], "properties": { "integrationId": { "type": "string" }, "configurationId": { "type": "string" }, "integrationSlug": { "type": "string" }, "integrationName": { "type": "string" }, "ownerId": { "type": "string" }, "projectIds": { "type": "array", "items": { "type": "string" } }, "confirmedScopes": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "configurations", "ownerId" ], "properties": { "configurations": { "type": "array", "items": { "type": "object", "required": [ "configurationId", "integrationId", "integrationSlug" ], "properties": { "integrationId": { "type": "string" }, "configurationId": { "type": "string" }, "integrationSlug": { "type": "string" }, "integrationName": { "type": "string" } } } }, "ownerId": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "billingPlanId", "configurationId", "integrationId", "integrationName", "integrationSlug", "ownerId" ], "properties": { "integrationId": { "type": "string" }, "configurationId": { "type": "string" }, "integrationSlug": { "type": "string" }, "integrationName": { "type": "string" }, "ownerId": { "type": "string" }, "billingPlanId": { "type": "string" }, "billingPlanName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "configurationId", "integrationId", "integrationName", "integrationSlug", "ownerId" ], "properties": { "integrationId": { "type": "string" }, "configurationId": { "type": "string" }, "integrationSlug": { "type": "string" }, "integrationName": { "type": "string" }, "ownerId": { "type": "string" }, "projectIds": { "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string", "enum": [ "all" ] } ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "integrationId", "integrationName", "integrationSlug" ], "properties": { "integrationId": { "type": "string" }, "integrationSlug": { "type": "string" }, "integrationName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "logDrainUrl" ], "properties": { "logDrainUrl": { "type": "string", "nullable": true }, "integrationName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "logDrainUrl" ], "properties": { "logDrainUrl": { "type": "string" }, "integrationName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "userAgent": { "type": "string" }, "geolocation": { "type": "object", "nullable": true, "required": [ "country" ], "properties": { "city": { "type": "object", "required": [ "names" ], "properties": { "names": { "type": "object", "required": [ "en" ], "properties": { "en": { "type": "string" } } } } }, "country": { "type": "object", "required": [ "names" ], "properties": { "names": { "type": "object", "required": [ "en" ], "properties": { "en": { "type": "string" } } } } }, "most_specific_subdivision": { "type": "object", "required": [ "names" ], "properties": { "names": { "type": "object", "required": [ "en" ], "properties": { "en": { "type": "string" } } } } }, "regionName": { "type": "string" } } }, "env": { "type": "string" }, "os": { "type": "string" }, "username": { "type": "string" }, "ssoType": { "type": "string" }, "factors": { "oneOf": [ { "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "origin" ], "properties": { "origin": { "type": "string", "enum": [ "email", "saml", "github", "gitlab", "bitbucket", "google", "apple", "chatgpt", "webauthn", "otp", "invite", "otp-link", "magic-link" ] }, "username": { "type": "string" }, "teamId": { "type": "string" }, "legacy": { "type": "boolean", "enum": [ false, true ] }, "ssoType": { "type": "string" } } } ] } }, { "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "origin" ], "properties": { "origin": { "type": "string", "enum": [ "email", "saml", "github", "gitlab", "bitbucket", "google", "apple", "chatgpt", "webauthn", "otp", "invite", "otp-link", "magic-link" ] }, "username": { "type": "string" }, "teamId": { "type": "string" }, "legacy": { "type": "boolean", "enum": [ false, true ] }, "ssoType": { "type": "string" } } }, { "type": "object", "required": [ "origin" ], "properties": { "origin": { "type": "string", "enum": [ "totp", "webauthn", "recovery-code" ] } } } ] } } ] }, "viaOTP": { "type": "boolean", "enum": [ false, true ] }, "viaGithub": { "type": "boolean", "enum": [ false, true ] }, "viaGitlab": { "type": "boolean", "enum": [ false, true ] }, "viaBitbucket": { "type": "boolean", "enum": [ false, true ] }, "viaGoogle": { "type": "boolean", "enum": [ false, true ] }, "viaApple": { "type": "boolean", "enum": [ false, true ] }, "viaSamlSso": { "type": "boolean", "enum": [ false, true ] }, "viaPasskey": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId", "projectName", "toDeploymentId" ], "properties": { "projectId": { "type": "string" }, "toDeploymentId": { "type": "string" }, "projectName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "id", "name", "slug" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "id", "prev" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "fallbackEnvironment": { "type": "string" }, "prev": { "type": "object", "required": [ "fallbackEnvironment", "name", "slug" ], "properties": { "name": { "type": "string" }, "slug": { "type": "string" }, "fallbackEnvironment": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "group", "project" ], "properties": { "project": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "group": { "type": "object", "required": [ "id", "name", "slug" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "group", "prev", "project" ], "properties": { "project": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "microfrontends": { "oneOf": [ { "type": "object", "required": [ "enabled", "groupIds", "isDefaultApp", "updatedAt" ], "properties": { "isDefaultApp": { "type": "boolean", "enum": [ true ] }, "updatedAt": { "type": "number", "description": "Timestamp when the microfrontends settings were last updated." }, "groupIds": { "type": "array", "description": "The group IDs of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together.", "items": { "type": "string" } }, "enabled": { "type": "boolean", "description": "Whether microfrontends are enabled for this project.", "enum": [ true ] }, "defaultRoute": { "type": "string", "description": "A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI. Includes the leading slash, e.g. `/docs`" }, "freeProjectForLegacyLimits": { "type": "boolean", "description": "Whether the project was part of the legacy limits for hobby and pro-trial before billing was added. This field is only set when the team is upgraded to a paid plan and we are backfilling the subscription status. We cap the subscription to 2 projects and set this field for the 3rd project. When this field is set, the project is not charged for and we do not call any billing APIs for this project.", "enum": [ false, true ] } } }, { "type": "object", "required": [ "enabled", "groupIds", "updatedAt" ], "properties": { "isDefaultApp": { "type": "boolean", "enum": [ false ] }, "routeObservabilityToThisProject": { "type": "boolean", "description": "Whether observability data should be routed to this microfrontend project or a root project.", "enum": [ false, true ] }, "doNotRouteWithMicrofrontendsRouting": { "type": "boolean", "description": "Whether to add microfrontends routing to aliases. This means domains in this project will route as a microfrontend.", "enum": [ false, true ] }, "updatedAt": { "type": "number", "description": "Timestamp when the microfrontends settings were last updated." }, "groupIds": { "type": "array", "description": "The group IDs of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together.", "items": { "type": "string" } }, "enabled": { "type": "boolean", "description": "Whether microfrontends are enabled for this project.", "enum": [ true ] }, "defaultRoute": { "type": "string", "description": "A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI. Includes the leading slash, e.g. `/docs`" }, "freeProjectForLegacyLimits": { "type": "boolean", "description": "Whether the project was part of the legacy limits for hobby and pro-trial before billing was added. This field is only set when the team is upgraded to a paid plan and we are backfilling the subscription status. We cap the subscription to 2 projects and set this field for the 3rd project. When this field is set, the project is not charged for and we do not call any billing APIs for this project.", "enum": [ false, true ] } } }, { "type": "object", "required": [ "enabled", "groupIds", "updatedAt" ], "properties": { "updatedAt": { "type": "number" }, "groupIds": { "type": "array", "items": {} }, "enabled": { "type": "boolean", "enum": [ false ] }, "freeProjectForLegacyLimits": { "type": "boolean", "enum": [ false, true ] } } } ] } } }, "prev": { "type": "object", "required": [ "project" ], "properties": { "project": { "type": "object", "properties": { "microfrontends": { "oneOf": [ { "type": "object", "required": [ "enabled", "groupIds", "isDefaultApp", "updatedAt" ], "properties": { "isDefaultApp": { "type": "boolean", "enum": [ true ] }, "updatedAt": { "type": "number", "description": "Timestamp when the microfrontends settings were last updated." }, "groupIds": { "type": "array", "description": "The group IDs of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together.", "items": { "type": "string" } }, "enabled": { "type": "boolean", "description": "Whether microfrontends are enabled for this project.", "enum": [ true ] }, "defaultRoute": { "type": "string", "description": "A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI. Includes the leading slash, e.g. `/docs`" }, "freeProjectForLegacyLimits": { "type": "boolean", "description": "Whether the project was part of the legacy limits for hobby and pro-trial before billing was added. This field is only set when the team is upgraded to a paid plan and we are backfilling the subscription status. We cap the subscription to 2 projects and set this field for the 3rd project. When this field is set, the project is not charged for and we do not call any billing APIs for this project.", "enum": [ false, true ] } } }, { "type": "object", "required": [ "enabled", "groupIds", "updatedAt" ], "properties": { "isDefaultApp": { "type": "boolean", "enum": [ false ] }, "routeObservabilityToThisProject": { "type": "boolean", "description": "Whether observability data should be routed to this microfrontend project or a root project.", "enum": [ false, true ] }, "doNotRouteWithMicrofrontendsRouting": { "type": "boolean", "description": "Whether to add microfrontends routing to aliases. This means domains in this project will route as a microfrontend.", "enum": [ false, true ] }, "updatedAt": { "type": "number", "description": "Timestamp when the microfrontends settings were last updated." }, "groupIds": { "type": "array", "description": "The group IDs of microfrontends that this project belongs to. Each microfrontend project must belong to a microfrontends group that is the set of microfrontends that are used together.", "items": { "type": "string" } }, "enabled": { "type": "boolean", "description": "Whether microfrontends are enabled for this project.", "enum": [ true ] }, "defaultRoute": { "type": "string", "description": "A path that is used to take screenshots and as the default path in preview links when a domain for this microfrontend is shown in the UI. Includes the leading slash, e.g. `/docs`" }, "freeProjectForLegacyLimits": { "type": "boolean", "description": "Whether the project was part of the legacy limits for hobby and pro-trial before billing was added. This field is only set when the team is upgraded to a paid plan and we are backfilling the subscription status. We cap the subscription to 2 projects and set this field for the 3rd project. When this field is set, the project is not charged for and we do not call any billing APIs for this project.", "enum": [ false, true ] } } }, { "type": "object", "required": [ "enabled", "groupIds", "updatedAt" ], "properties": { "updatedAt": { "type": "number" }, "groupIds": { "type": "array", "items": {} }, "enabled": { "type": "boolean", "enum": [ false ] }, "freeProjectForLegacyLimits": { "type": "boolean", "enum": [ false, true ] } } } ] } } } } }, "group": { "type": "object", "required": [ "id", "name", "slug" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectName" ], "properties": { "projectName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "cause", "ownerId", "source" ], "properties": { "ownerId": { "type": "string" }, "source": { "type": "string" }, "cause": { "type": "string" }, "blockReason": { "type": "string" }, "siftRoute": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "cause", "ownerId", "source" ], "properties": { "ownerId": { "type": "string" }, "source": { "type": "string" }, "cause": { "type": "string" }, "reason": { "type": "string", "nullable": true } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "cause", "ownerId", "source" ], "properties": { "ownerId": { "type": "string" }, "source": { "type": "string" }, "cause": { "type": "string" }, "blockReason": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "cause", "ownerId", "source" ], "properties": { "ownerId": { "type": "string" }, "source": { "type": "string" }, "cause": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "newName", "oldName" ], "properties": { "oldName": { "type": "string" }, "newName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "plan" ], "properties": { "plan": { "type": "string" }, "removedUsers": { "type": "object", "additionalProperties": { "type": "object", "required": [ "confirmed", "role" ], "properties": { "role": { "type": "string", "enum": [ "OWNER", "MEMBER", "DEVELOPER", "SECURITY", "BILLING", "VIEWER", "VIEWER_FOR_PLUS", "CONTRIBUTOR" ] }, "confirmed": { "type": "boolean", "enum": [ false, true ] }, "confirmedAt": { "type": "number" }, "joinedFrom": { "type": "object", "required": [ "origin" ], "properties": { "origin": { "type": "string", "enum": [ "link", "import", "teams", "saml", "github", "gitlab", "bitbucket", "mail", "dsync", "feedback", "organization-teams", "nsnb-auto-approve", "nsnb-hobby-upgrade", "nsnb-request-access", "nsnb-viewer-upgrade", "nsnb-invite", "nsnb-redeploy" ] }, "commitId": { "type": "string" }, "repoId": { "type": "string" }, "repoPath": { "type": "string" }, "gitUserId": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "gitUserLogin": { "type": "string" }, "ssoUserId": { "type": "string" }, "ssoConnectedAt": { "type": "number" }, "idpUserId": { "type": "string" }, "dsyncUserId": { "type": "string" }, "dsyncConnectedAt": { "type": "number" } } } } } }, "prevPlan": { "type": "string" }, "priorPlan": { "type": "string" }, "isDowngrade": { "type": "boolean", "enum": [ false, true ] }, "userAgent": { "type": "string" }, "isReactivate": { "type": "boolean", "enum": [ false, true ] }, "isTrialUpgrade": { "type": "boolean", "enum": [ false, true ] }, "automated": { "type": "boolean", "description": "Whether the plan change was system-initiated rather than human-initiated.", "enum": [ false, true ] }, "reason": { "type": "string", "description": "Why the plan changed. For downgrades, this is a {@link DowngradeReason} from `@api/pubsub-types` (e.g. `user_downgrade`, `trial_expired`)." }, "timestamp": { "type": "number" }, "removedMemberCount": { "type": "number" } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "price": { "type": "number" }, "currency": { "type": "string" }, "enabled": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "previewDeploymentSuffix": { "type": "string", "nullable": true }, "previousPreviewDeploymentSuffix": { "type": "string", "nullable": true } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "privateLinkEndpoint", "projectId" ], "properties": { "privateLinkEndpoint": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "projectId": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "branch", "projectName" ], "properties": { "projectName": { "type": "string" }, "branch": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "directoryListing", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "directoryListing": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "prevProjectAnalytics", "projectAnalytics", "projectId" ], "properties": { "projectName": { "type": "string" }, "projectId": { "type": "string" }, "projectAnalytics": { "type": "object", "nullable": true, "required": [ "disabledAt", "enabledAt", "id" ], "properties": { "id": { "type": "string" }, "canceledAt": { "type": "number", "nullable": true }, "disabledAt": { "type": "number" }, "enabledAt": { "type": "number" }, "paidAt": { "type": "number" }, "sampleRatePercent": { "type": "number", "nullable": true }, "spendLimitInDollars": { "type": "number", "nullable": true } } }, "prevProjectAnalytics": { "type": "object", "nullable": true, "required": [ "disabledAt", "enabledAt", "id" ], "properties": { "id": { "type": "string" }, "canceledAt": { "type": "number", "nullable": true }, "disabledAt": { "type": "number" }, "enabledAt": { "type": "number" }, "paidAt": { "type": "number" }, "sampleRatePercent": { "type": "number", "nullable": true }, "spendLimitInDollars": { "type": "number", "nullable": true } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId" ], "properties": { "projectName": { "type": "string" }, "projectId": { "type": "string" }, "projectAnalytics": { "type": "object", "additionalProperties": true }, "prevProjectAnalytics": { "type": "object", "nullable": true, "additionalProperties": true } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "action", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "action": { "type": "string", "enum": [ "enabled", "disabled", "regenerated", "updated" ] }, "isEnvVar": { "type": "boolean", "enum": [ false, true ] }, "note": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "enableAffectedProjectsDeployments", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "enableAffectedProjectsDeployments": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "enableExternalRewriteCaching", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "enableExternalRewriteCaching": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "next", "previous", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "previous": { "type": "object" }, "next": { "type": "object" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "productionDeploymentsFastLane", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "productionDeploymentsFastLane": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId", "projectName", "sourceFilesOutsideRootDirectory" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "sourceFilesOutsideRootDirectory": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "nextBuildMachineSelection", "nextBuildMachineType", "previousBuildMachineSelection", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "previousBuildMachineType": { "type": "string" }, "nextBuildMachineType": { "type": "string" }, "previousBuildMachineSelection": { "type": "string" }, "nextBuildMachineSelection": { "type": "string" }, "isSystemInitiated": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "certId": { "type": "string" }, "origin": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "target": { "type": "array", "items": { "type": "string" } }, "updated": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "project", "team" ], "properties": { "team": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "project": { "type": "object", "required": [ "id", "newConnectConfigurations", "oldConnectConfigurations" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "oldConnectConfigurations": { "type": "array", "nullable": true, "items": { "type": "object", "required": [ "buildsEnabled", "connectConfigurationId", "createdAt", "envId", "passive", "updatedAt" ], "properties": { "envId": { "oneOf": [ { "type": "string" }, { "type": "string", "enum": [ "production", "preview" ] } ] }, "connectConfigurationId": { "type": "string" }, "dc": { "type": "string" }, "passive": { "type": "boolean", "enum": [ false, true ] }, "buildsEnabled": { "type": "boolean", "enum": [ false, true ] }, "aws": { "type": "object", "required": [ "subnetIds" ], "properties": { "subnetIds": { "type": "array", "items": { "type": "string" } }, "securityGroupId": { "type": "string" } } }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } } } }, "newConnectConfigurations": { "type": "array", "nullable": true, "items": { "type": "object", "required": [ "buildsEnabled", "connectConfigurationId", "createdAt", "envId", "passive", "updatedAt" ], "properties": { "envId": { "oneOf": [ { "type": "string" }, { "type": "string", "enum": [ "production", "preview" ] } ] }, "connectConfigurationId": { "type": "string" }, "dc": { "type": "string" }, "passive": { "type": "boolean", "enum": [ false, true ] }, "buildsEnabled": { "type": "boolean", "enum": [ false, true ] }, "aws": { "type": "object", "required": [ "subnetIds" ], "properties": { "subnetIds": { "type": "array", "items": { "type": "string" } }, "securityGroupId": { "type": "string" } } }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } } } } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId" ], "properties": { "projectName": { "type": "string" }, "projectId": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "action", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "action": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "name", "ownerId" ], "properties": { "name": { "type": "string" }, "ownerId": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "elasticConcurrencyEnabled", "oldElasticConcurrencyEnabled", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "elasticConcurrencyEnabled": { "type": "boolean", "enum": [ false, true ] }, "oldElasticConcurrencyEnabled": { "type": "boolean", "enum": [ false, true ] }, "buildQueueConfiguration": { "type": "string", "enum": [ "SKIP_NAMESPACE_QUEUE", "WAIT_FOR_NAMESPACE_QUEUE" ] }, "oldBuildQueueConfiguration": { "type": "string", "enum": [ "SKIP_NAMESPACE_QUEUE", "WAIT_FOR_NAMESPACE_QUEUE" ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "autoAssignCustomDomains", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "autoAssignCustomDomains": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "previewDeploymentsEnabled", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "previewDeploymentsEnabled": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "customEnvironmentId", "customEnvironmentSlug", "next", "previous", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "customEnvironmentId": { "type": "string" }, "customEnvironmentSlug": { "type": "string" }, "previous": { "type": "object", "properties": { "branchMatcher": { "type": "object", "required": [ "pattern", "type" ], "properties": { "type": { "type": "string", "description": "The type of matching to perform", "enum": [ "endsWith", "startsWith", "equals" ] }, "pattern": { "type": "string", "description": "The pattern to match against branch names" } } } } }, "next": { "type": "object", "properties": { "branchMatcher": { "type": "object", "required": [ "pattern", "type" ], "properties": { "type": { "type": "string", "description": "The type of matching to perform", "enum": [ "endsWith", "startsWith", "equals" ] }, "pattern": { "type": "string", "description": "The pattern to match against branch names" } } } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "customEnvironmentId", "customEnvironmentSlug", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "customEnvironmentId": { "type": "string" }, "customEnvironmentSlug": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "next", "previous", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "previous": { "type": "object", "required": [ "functionDefaultTimeout" ], "properties": { "functionDefaultTimeout": { "type": "number", "nullable": true } } }, "next": { "type": "object", "required": [ "functionDefaultTimeout" ], "properties": { "functionDefaultTimeout": { "type": "number" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "next", "previous", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "previous": { "type": "object", "required": [ "functionDefaultMemoryType" ], "properties": { "functionDefaultMemoryType": { "type": "string", "nullable": true } } }, "next": { "type": "object", "required": [ "functionDefaultMemoryType" ], "properties": { "functionDefaultMemoryType": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "next", "previous", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "previous": { "type": "object", "required": [ "functionDefaultRegions" ], "properties": { "functionDefaultRegions": { "type": "array", "nullable": true, "items": { "type": "string" } } } }, "next": { "type": "object", "required": [ "functionDefaultRegions" ], "properties": { "functionDefaultRegions": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "next", "previous", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "previous": { "type": "object", "required": [ "functionZeroConfigFailover" ], "properties": { "functionZeroConfigFailover": { "type": "boolean", "enum": [ false, true ], "nullable": true } } }, "next": { "type": "object", "required": [ "functionZeroConfigFailover" ], "properties": { "functionZeroConfigFailover": { "type": "boolean", "enum": [ false, true ] } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "previewDeploymentSuffix", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "previewDeploymentSuffix": { "type": "string", "nullable": true } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "newProjectName", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "newProjectName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "next", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "previous": { "type": "object", "required": [ "gitProvider", "gitRepoId", "gitRepositoryName" ], "properties": { "gitProvider": { "type": "string", "enum": [ "vercel", "github", "github-limited", "github-custom-host", "gitlab", "bitbucket" ] }, "gitRepoId": { "type": "string" }, "gitRepositoryName": { "type": "string" } } }, "next": { "type": "object", "required": [ "gitProvider", "gitRepoId", "gitRepositoryName" ], "properties": { "gitProvider": { "type": "string", "enum": [ "vercel", "github", "github-limited", "github-custom-host", "gitlab", "bitbucket" ] }, "gitRepoId": { "type": "string" }, "gitRepositoryName": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "gitProvider", "gitRepoId", "gitRepositoryName", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "gitProvider": { "type": "string", "enum": [ "vercel", "github", "github-limited", "github-custom-host", "gitlab", "bitbucket" ] }, "gitRepoId": { "type": "string" }, "gitRepositoryName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "onPullRequest", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "onPullRequest": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "onCommit", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "onCommit": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "disableRepositoryDispatchEvents", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "disableRepositoryDispatchEvents": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "createDeployments", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "createDeployments": { "type": "string", "enum": [ "enabled", "disabled" ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId", "projectName", "requireVerifiedCommits" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "requireVerifiedCommits": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "gitLFS", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "gitLFS": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "consolidatedGitCommitStatus", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "consolidatedGitCommitStatus": { "type": "object", "nullable": true, "required": [ "enabled", "propagateFailures" ], "properties": { "enabled": { "type": "boolean", "enum": [ false, true ] }, "propagateFailures": { "type": "boolean", "enum": [ false, true ] } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "next", "previous", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "previous": { "type": "object", "properties": { "commandForIgnoringBuildStep": { "type": "string" } } }, "next": { "type": "object", "properties": { "commandForIgnoringBuildStep": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "domain", "gitBranch", "projectId", "projectName", "redirect", "redirectStatusCode", "target" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "domain": { "type": "string" }, "target": { "type": "string" }, "redirect": { "type": "string", "nullable": true }, "redirectStatusCode": { "type": "number", "nullable": true }, "gitBranch": { "type": "string", "nullable": true }, "configuredBy": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "domain", "projectId", "projectName", "target" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "domain": { "type": "string" }, "target": { "type": "string" }, "redirect": { "type": "string", "nullable": true }, "redirectStatusCode": { "type": "number", "nullable": true } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "domain", "newProjectId", "newProjectName", "oldProjectId", "oldProjectName" ], "properties": { "oldProjectId": { "type": "string" }, "oldProjectName": { "type": "string" }, "newProjectId": { "type": "string" }, "newProjectName": { "type": "string" }, "domain": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "domain", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "domain": { "type": "string" }, "redirect": { "type": "string", "nullable": true }, "redirectStatusCode": { "type": "number", "nullable": true } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projects", "uid" ], "properties": { "projects": { "type": "array", "items": { "type": "object", "required": [ "membershipCreatedAt", "projectId", "role" ], "properties": { "projectId": { "type": "string" }, "role": { "type": "string", "enum": [ "ADMIN", "PROJECT_DEVELOPER", "PROJECT_VIEWER", "PROJECT_GUEST" ] }, "membershipCreatedAt": { "type": "number" } } } }, "uid": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "domain", "projectId", "projectName", "target" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "target": { "type": "string" }, "domain": { "type": "string" }, "configuredBy": { "type": "string", "nullable": true }, "prevConfiguredBy": { "type": "string", "nullable": true } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "project", "projectMembership" ], "properties": { "project": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "id": { "type": "string" } } }, "projectMembership": { "type": "object", "nullable": true, "required": [ "createdAt", "role", "uid" ], "properties": { "role": { "type": "string", "enum": [ "ADMIN", "PROJECT_DEVELOPER", "PROJECT_VIEWER", "PROJECT_GUEST" ] }, "uid": { "type": "string" }, "createdAt": { "type": "number" }, "username": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "project" ], "properties": { "project": { "type": "object", "required": [ "invitedUserName", "name", "role" ], "properties": { "name": { "type": "string" }, "role": { "type": "string", "enum": [ "ADMIN", "PROJECT_DEVELOPER", "PROJECT_VIEWER", "PROJECT_GUEST" ] }, "invitedUserName": { "type": "string" }, "id": { "type": "string" }, "invitedUserId": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "project", "removedMembership" ], "properties": { "project": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "id": { "type": "string" } } }, "removedMembership": { "type": "object", "required": [ "createdAt", "role", "uid" ], "properties": { "role": { "type": "string", "enum": [ "ADMIN", "PROJECT_DEVELOPER", "PROJECT_VIEWER", "PROJECT_GUEST" ] }, "uid": { "type": "string" }, "createdAt": { "type": "number" }, "username": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "project", "projectMembership" ], "properties": { "project": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "projectMembership": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "ADMIN", "PROJECT_DEVELOPER", "PROJECT_VIEWER", "PROJECT_GUEST" ] }, "uid": { "type": "string" }, "createdAt": { "type": "number" }, "username": { "type": "string" }, "previousRole": { "type": "string", "enum": [ "ADMIN", "PROJECT_DEVELOPER", "PROJECT_VIEWER", "PROJECT_GUEST" ] } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "newProjectName", "originAccountName", "previousProjectName" ], "properties": { "previousProjectName": { "type": "string" }, "newProjectName": { "type": "string" }, "originAccountName": { "type": "string" }, "transferId": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "destinationAccountName", "projectName" ], "properties": { "projectName": { "type": "string" }, "destinationAccountName": { "type": "string", "nullable": true }, "transferId": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "destinationAccountId", "destinationAccountName", "originAccountName", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "originAccountName": { "type": "string" }, "destinationAccountName": { "type": "string" }, "destinationAccountId": { "type": "string" }, "transferId": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "destinationAccountName", "newProjectName", "previousProjectName" ], "properties": { "previousProjectName": { "type": "string" }, "newProjectName": { "type": "string" }, "destinationAccountName": { "type": "string" }, "transferId": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId", "projectName", "source" ], "properties": { "source": { "type": "string" }, "projectId": { "type": "string" }, "projectName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "optionsAllowlist": { "type": "object", "nullable": true, "required": [ "paths" ], "properties": { "paths": { "type": "array", "items": { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string" } } } } } }, "oldOptionsAllowlist": { "type": "object", "nullable": true, "required": [ "paths" ], "properties": { "paths": { "type": "array", "items": { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string" } } } } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "oldPasswordProtection", "passwordProtection" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "passwordProtection": { "nullable": true, "oneOf": [ { "type": "object", "required": [ "deploymentType" ], "properties": { "deploymentType": { "type": "string", "enum": [ "all", "preview", "prod_deployment_urls_and_all_previews", "all_except_custom_domains" ] } } }, { "type": "string", "enum": [ "all", "preview", "prod_deployment_urls_and_all_previews", "all_except_custom_domains" ] } ] }, "oldPasswordProtection": { "nullable": true, "oneOf": [ { "type": "object", "required": [ "deploymentType" ], "properties": { "deploymentType": { "type": "string", "enum": [ "all", "preview", "prod_deployment_urls_and_all_previews", "all_except_custom_domains" ] } } }, { "type": "string", "enum": [ "all", "preview", "prod_deployment_urls_and_all_previews", "all_except_custom_domains" ] } ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId" ], "properties": { "projectId": { "type": "string" }, "reasonCode": { "type": "string", "enum": [ "BUDGET_REACHED", "PUBLIC_API", "BACKOFFICE" ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "consent", "projectName" ], "properties": { "projectName": { "type": "string" }, "consent": { "type": "string", "enum": [ "granted", "refused" ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "targetDeploymentId": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "targetDeploymentId": { "type": "string" }, "newTargetPercentage": { "type": "number" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "next", "previous", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "previous": { "type": "object", "properties": { "issuerMode": { "type": "string", "enum": [ "team", "global" ] } } }, "next": { "type": "object", "required": [ "issuerMode" ], "properties": { "issuerMode": { "type": "string", "enum": [ "team", "global" ] } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "customerSupportCodeVisibility", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "customerSupportCodeVisibility": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "gitForkProtection", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "gitForkProtection": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId", "projectName", "protectedSourcemaps" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "protectedSourcemaps": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId", "projectName", "publicSource" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "publicSource": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "next", "previous" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "previous": { "type": "object", "properties": { "expiration": { "type": "string" }, "expirationProduction": { "type": "string" }, "expirationCanceled": { "type": "string" }, "expirationErrored": { "type": "string" } } }, "next": { "type": "object", "properties": { "expiration": { "type": "string" }, "expirationProduction": { "type": "string" }, "expirationCanceled": { "type": "string" }, "expirationErrored": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "next", "previous", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "next": { "type": "object", "required": [ "skewProtectionBoundaryAt" ], "properties": { "skewProtectionBoundaryAt": { "type": "number" } } }, "previous": { "type": "object", "properties": { "skewProtectionBoundaryAt": { "type": "number" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "next", "previous", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "next": { "type": "object", "required": [ "skewProtectionMaxAge" ], "properties": { "skewProtectionMaxAge": { "type": "number" } } }, "previous": { "type": "object", "properties": { "skewProtectionMaxAge": { "type": "number" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "next", "previous", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "next": { "type": "object", "required": [ "skewProtectionAllowedDomains" ], "properties": { "skewProtectionAllowedDomains": { "type": "array", "items": { "type": "string" } } } }, "previous": { "type": "object", "properties": { "skewProtectionAllowedDomains": { "type": "array", "items": { "type": "string" } } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "oldSsoProtection", "ssoProtection" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "ssoProtection": { "nullable": true, "oneOf": [ { "type": "object", "required": [ "deploymentType" ], "properties": { "deploymentType": { "type": "string", "enum": [ "all", "preview", "prod_deployment_urls_and_all_previews", "all_except_custom_domains" ] }, "cve55182MigrationAppliedFrom": { "type": "string", "enum": [ "all", "preview", "prod_deployment_urls_and_all_previews", "all_except_custom_domains" ], "nullable": true } } }, { "type": "string", "enum": [ "all", "preview", "prod_deployment_urls_and_all_previews", "all_except_custom_domains" ] } ] }, "oldSsoProtection": { "nullable": true, "oneOf": [ { "type": "object", "required": [ "deploymentType" ], "properties": { "deploymentType": { "type": "string", "enum": [ "all", "preview", "prod_deployment_urls_and_all_previews", "all_except_custom_domains" ] }, "cve55182MigrationAppliedFrom": { "type": "string", "enum": [ "all", "preview", "prod_deployment_urls_and_all_previews", "all_except_custom_domains" ], "nullable": true } } }, { "type": "string", "enum": [ "all", "preview", "prod_deployment_urls_and_all_previews", "all_except_custom_domains" ] } ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "next", "previous", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "next": { "type": "object", "required": [ "project" ], "properties": { "project": { "type": "object", "required": [ "staticIps" ], "properties": { "id": { "type": "string" }, "staticIps": { "type": "object", "required": [ "enabled" ], "properties": { "builds": { "type": "boolean", "enum": [ false, true ] }, "enabled": { "type": "boolean", "enum": [ false, true ] }, "regions": { "type": "array", "items": { "type": "string" } } } } } } } }, "previous": { "type": "object", "required": [ "project" ], "properties": { "project": { "type": "object", "required": [ "staticIps" ], "properties": { "id": { "type": "string" }, "staticIps": { "type": "object", "required": [ "enabled" ], "properties": { "builds": { "type": "boolean", "enum": [ false, true ] }, "enabled": { "type": "boolean", "enum": [ false, true ] }, "regions": { "type": "array", "items": { "type": "string" } } } } } } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "trustedIps": { "type": "string", "enum": [ "production", "all", "preview", "prod_deployment_urls_and_all_previews", "all_except_custom_domains" ], "nullable": true }, "oldTrustedIps": { "type": "string", "enum": [ "production", "all", "preview", "prod_deployment_urls_and_all_previews", "all_except_custom_domains" ], "nullable": true }, "addedAddresses": { "type": "array", "nullable": true, "items": { "type": "string" } }, "removedAddresses": { "type": "array", "nullable": true, "items": { "type": "string" } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId" ], "properties": { "projectId": { "type": "string" }, "reasonCode": { "type": "string", "enum": [ "PUBLIC_API", "BACKOFFICE" ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "projectWebAnalytics": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "disabledAt": { "type": "number" }, "canceledAt": { "type": "number" }, "enabledAt": { "type": "number" }, "hasData": { "type": "boolean", "enum": [ true ] } } }, "prevProjectWebAnalytics": { "type": "object", "nullable": true, "required": [ "id" ], "properties": { "id": { "type": "string" }, "disabledAt": { "type": "number" }, "canceledAt": { "type": "number" }, "enabledAt": { "type": "number" }, "hasData": { "type": "boolean", "enum": [ true ] } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "gitProvider", "gitProviderGroupDescriptor", "gitScope" ], "properties": { "gitProvider": { "type": "string" }, "gitProviderGroupDescriptor": { "type": "string" }, "gitScope": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "instances", "url" ], "properties": { "instances": { "type": "number" }, "url": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "email", "verified" ], "properties": { "email": { "type": "string" }, "verified": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "email" ], "properties": { "email": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "name", "uid" ], "properties": { "uid": { "type": "string" }, "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } } ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "newName", "oldName" ], "properties": { "oldName": { "type": "string" }, "newName": { "type": "string" }, "uid": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "enabled", "updatedAt" ], "properties": { "enabled": { "type": "boolean", "enum": [ false, true ] }, "updatedAt": { "type": "number" }, "firstEnabledAt": { "type": "number" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "bio" ], "properties": { "bio": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "max", "min", "scalingRules", "url" ], "properties": { "scalingRules": { "type": "object", "additionalProperties": { "type": "object", "required": [ "max", "min" ], "properties": { "min": { "type": "number" }, "max": { "type": "number" } } } }, "min": { "type": "number" }, "max": { "type": "number" }, "url": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "userAgent": { "type": "string" }, "geolocation": { "type": "object", "nullable": true, "required": [ "country" ], "properties": { "city": { "type": "object", "required": [ "names" ], "properties": { "names": { "type": "object", "required": [ "en" ], "properties": { "en": { "type": "string" } } } } }, "country": { "type": "object", "required": [ "names" ], "properties": { "names": { "type": "object", "required": [ "en" ], "properties": { "en": { "type": "string" } } } } }, "most_specific_subdivision": { "type": "object", "required": [ "names" ], "properties": { "names": { "type": "object", "required": [ "en" ], "properties": { "en": { "type": "string" } } } } }, "regionName": { "type": "string" } } }, "env": { "type": "string" }, "os": { "type": "string" }, "username": { "type": "string" }, "ssoType": { "type": "string" }, "factors": { "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "origin" ], "properties": { "origin": { "type": "string", "enum": [ "email", "saml", "github", "gitlab", "bitbucket", "google", "apple", "chatgpt", "otp" ] }, "username": { "type": "string" }, "teamId": { "type": "string" }, "legacy": { "type": "boolean", "enum": [ false, true ] }, "ssoType": { "type": "string" } } } ] } }, "viaOTP": { "type": "boolean", "enum": [ false, true ] }, "viaGithub": { "type": "boolean", "enum": [ false, true ] }, "viaGitlab": { "type": "boolean", "enum": [ false, true ] }, "viaBitbucket": { "type": "boolean", "enum": [ false, true ] }, "viaGoogle": { "type": "boolean", "enum": [ false, true ] }, "viaApple": { "type": "boolean", "enum": [ false, true ] }, "viaSamlSso": { "type": "boolean", "enum": [ false, true ] }, "viaPasskey": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "bitbucketEmail", "bitbucketLogin", "bitbucketName", "email", "zeitAccount", "zeitAccountType" ], "properties": { "email": { "type": "string" }, "bitbucketLogin": { "type": "string" }, "bitbucketEmail": { "type": "string" }, "bitbucketName": { "type": "string" }, "zeitAccount": { "type": "string" }, "zeitAccountType": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "email", "githubLogin", "zeitAccount", "zeitAccountType" ], "properties": { "email": { "type": "string" }, "githubLogin": { "type": "string" }, "zeitAccount": { "type": "string" }, "zeitAccountType": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "email", "gitlabEmail", "gitlabLogin", "gitlabName", "zeitAccount", "zeitAccountType" ], "properties": { "email": { "type": "string" }, "gitlabLogin": { "type": "string" }, "gitlabEmail": { "type": "string" }, "gitlabName": { "type": "string" }, "zeitAccount": { "type": "string" }, "zeitAccountType": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "previous", "sampleRatePercent", "spendLimitInDollars" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "analyticsId": { "type": "string" }, "sampleRatePercent": { "type": "number", "nullable": true }, "spendLimitInDollars": { "type": "number", "nullable": true }, "previous": { "type": "object", "required": [ "sampleRatePercent", "spendLimitInDollars" ], "properties": { "sampleRatePercent": { "type": "number", "nullable": true }, "spendLimitInDollars": { "type": "number", "nullable": true } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "budget" ], "properties": { "budget": { "type": "object", "required": [ "budgetItem" ], "properties": { "budgetItem": { "type": "object", "description": "Represents a budget for tracking and notifying teams on their spending.", "required": [ "createdAt", "fixedBudget", "id", "isActive", "notifiedAt", "previousSpend", "teamId", "type" ], "properties": { "type": { "type": "string", "description": "The budget type", "enum": [ "fixed" ] }, "fixedBudget": { "type": "number", "description": "Budget amount (USD / dollars)" }, "previousSpend": { "type": "array", "description": "Array of the last 3 months of spend data", "items": { "type": "number" } }, "notifiedAt": { "type": "array", "description": "Array of 50, 75, 100 to keep track of notifications sent out", "items": { "type": "number" } }, "webhookId": { "type": "string", "description": "Webhook id that corresponds to a webhook in Cosmos webhook collection" }, "webhookNotified": { "type": "boolean", "description": "Keep track if the webhook has been called for the month", "enum": [ false, true ] }, "createdAt": { "type": "number", "description": "Date time when budget is created" }, "updatedAt": { "type": "number", "description": "Date time when budget is updated last" }, "isActive": { "type": "boolean", "description": "Is the budget currently active for a customer", "enum": [ false, true ] }, "pauseProjects": { "type": "boolean", "description": "Should all projects be paused if budget is exceeded", "enum": [ false, true ] }, "pricingPlan": { "type": "string", "description": "The acive pricing plan the team is billed with", "enum": [ "platform", "plus", "legacy", "unbundled" ] }, "teamId": { "type": "string", "description": "Partition key" }, "id": { "type": "string", "description": "Sort key that needs to be unique per teamId" } } } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "budget" ], "properties": { "budget": { "type": "object", "description": "Represents a budget for tracking and notifying teams on their spending.", "required": [ "createdAt", "fixedBudget", "id", "isActive", "notifiedAt", "previousSpend", "teamId", "type" ], "properties": { "type": { "type": "string", "description": "The budget type", "enum": [ "fixed" ] }, "fixedBudget": { "type": "number", "description": "Budget amount (USD / dollars)" }, "previousSpend": { "type": "array", "description": "Array of the last 3 months of spend data", "items": { "type": "number" } }, "notifiedAt": { "type": "array", "description": "Array of 50, 75, 100 to keep track of notifications sent out", "items": { "type": "number" } }, "webhookId": { "type": "string", "description": "Webhook id that corresponds to a webhook in Cosmos webhook collection" }, "webhookNotified": { "type": "boolean", "description": "Keep track if the webhook has been called for the month", "enum": [ false, true ] }, "createdAt": { "type": "number", "description": "Date time when budget is created" }, "updatedAt": { "type": "number", "description": "Date time when budget is updated last" }, "isActive": { "type": "boolean", "description": "Is the budget currently active for a customer", "enum": [ false, true ] }, "pauseProjects": { "type": "boolean", "description": "Should all projects be paused if budget is exceeded", "enum": [ false, true ] }, "pricingPlan": { "type": "string", "description": "The acive pricing plan the team is billed with", "enum": [ "platform", "plus", "legacy", "unbundled" ] }, "teamId": { "type": "string", "description": "Partition key" }, "id": { "type": "string", "description": "Sort key that needs to be unique per teamId" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "budget" ], "properties": { "budget": { "type": "object", "description": "Represents a budget for tracking and notifying teams on their spending.", "required": [ "createdAt", "fixedBudget", "id", "isActive", "notifiedAt", "previousSpend", "teamId", "type" ], "properties": { "type": { "type": "string", "description": "The budget type", "enum": [ "fixed" ] }, "fixedBudget": { "type": "number", "description": "Budget amount (USD / dollars)" }, "previousSpend": { "type": "array", "description": "Array of the last 3 months of spend data", "items": { "type": "number" } }, "notifiedAt": { "type": "array", "description": "Array of 50, 75, 100 to keep track of notifications sent out", "items": { "type": "number" } }, "webhookId": { "type": "string", "description": "Webhook id that corresponds to a webhook in Cosmos webhook collection" }, "webhookNotified": { "type": "boolean", "description": "Keep track if the webhook has been called for the month", "enum": [ false, true ] }, "createdAt": { "type": "number", "description": "Date time when budget is created" }, "updatedAt": { "type": "number", "description": "Date time when budget is updated last" }, "isActive": { "type": "boolean", "description": "Is the budget currently active for a customer", "enum": [ false, true ] }, "pauseProjects": { "type": "boolean", "description": "Should all projects be paused if budget is exceeded", "enum": [ false, true ] }, "pricingPlan": { "type": "string", "description": "The acive pricing plan the team is billed with", "enum": [ "platform", "plus", "legacy", "unbundled" ] }, "teamId": { "type": "string", "description": "Partition key" }, "id": { "type": "string", "description": "Sort key that needs to be unique per teamId" } } }, "webhookUrl": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "webhookUrl": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "storeType" ], "properties": { "storeType": { "type": "string", "enum": [ "redis", "postgres" ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "store", "transferRequestCode" ], "properties": { "transferRequestCode": { "type": "string" }, "store": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "integration", "redis", "postgres", "edge-config", "blob" ] } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "destinationTeamId", "destinationTeamName", "store", "transferRequestCode" ], "properties": { "transferRequestCode": { "type": "string" }, "store": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "integration", "redis", "postgres", "edge-config", "blob" ] } } }, "destinationTeamId": { "type": "string" }, "destinationTeamName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "originTeamId", "originTeamName", "store", "transferRequestCode" ], "properties": { "transferRequestCode": { "type": "string" }, "store": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "integration", "redis", "postgres", "edge-config", "blob" ] } } }, "originTeamId": { "type": "string" }, "originTeamName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "id", "type" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "computeUnitsMax": { "type": "number" }, "computeUnitsMin": { "type": "number" }, "suspendTimeoutSeconds": { "type": "number" }, "type": { "type": "string", "enum": [ "integration", "redis", "postgres", "edge-config", "blob" ] }, "access": { "type": "string", "enum": [ "public", "private" ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "store" ], "properties": { "store": { "type": "object", "required": [ "id", "name" ], "properties": { "name": { "type": "string" }, "id": { "type": "string" } } }, "ownerId": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "slug" ], "properties": { "slug": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "next" ], "properties": { "previous": { "type": "object", "description": "Automatic code review settings", "required": [ "enabled", "includeDrafts", "scope" ], "properties": { "enabled": { "type": "boolean", "description": "Whether automatic code reviews are enabled", "enum": [ false, true ] }, "scope": { "type": "string", "description": "Which repository visibilities get automatic reviews", "enum": [ "public", "private", "all", "selected_repos" ] }, "includeDrafts": { "type": "boolean", "description": "Whether to include draft pull requests in automatic reviews", "enum": [ false, true ] }, "selectedRepos": { "type": "array", "description": "GitHub repos to scope automatic reviews to. Format: \"owner/repo\" (lowercase). Only used when scope='selected_repos'.", "nullable": true, "items": { "type": "string" } } } }, "next": { "type": "object", "description": "Automatic code review settings", "required": [ "enabled", "includeDrafts", "scope" ], "properties": { "enabled": { "type": "boolean", "description": "Whether automatic code reviews are enabled", "enum": [ false, true ] }, "scope": { "type": "string", "description": "Which repository visibilities get automatic reviews", "enum": [ "public", "private", "all", "selected_repos" ] }, "includeDrafts": { "type": "boolean", "description": "Whether to include draft pull requests in automatic reviews", "enum": [ false, true ] }, "selectedRepos": { "type": "array", "description": "GitHub repos to scope automatic reviews to. Format: \"owner/repo\" (lowercase). Only used when scope='selected_repos'.", "nullable": true, "items": { "type": "string" } } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "amount", "currency", "expiresAt", "trialCreditsIssuedAt" ], "properties": { "trialCreditsIssuedAt": { "type": "number" }, "expiresAt": { "type": "string" }, "amount": { "type": "string" }, "currency": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "previous": { "type": "string", "enum": [ "enhanced", "turbo", "standard", "elastic" ] }, "next": { "type": "string", "enum": [ "enhanced", "turbo", "standard", "elastic" ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "by", "slug", "teamId" ], "properties": { "slug": { "type": "string" }, "teamId": { "type": "string" }, "by": { "type": "string" }, "byUid": { "type": "string" }, "reasons": { "type": "array", "items": { "type": "object", "required": [ "description", "slug" ], "properties": { "slug": { "type": "string" }, "description": { "type": "string" } } } }, "removedUsers": { "type": "object", "additionalProperties": { "type": "object", "required": [ "confirmed", "role" ], "properties": { "role": { "type": "string", "enum": [ "OWNER", "MEMBER", "DEVELOPER", "SECURITY", "BILLING", "VIEWER", "VIEWER_FOR_PLUS", "CONTRIBUTOR" ] }, "confirmed": { "type": "boolean", "enum": [ false, true ] }, "confirmedAt": { "type": "number" } } } }, "removedMemberCount": { "type": "number" }, "timestamp": { "type": "number" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "enum": [ false, true ] }, "domain": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "enabled", "environment", "projectId", "projectName" ], "properties": { "projectId": { "type": "string" }, "projectName": { "type": "string" }, "enabled": { "type": "boolean", "enum": [ false, true ], "nullable": true }, "environment": { "type": "string", "enum": [ "production", "preview" ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "enabled", "environment" ], "properties": { "environment": { "type": "string", "enum": [ "production", "preview" ] }, "enabled": { "type": "string", "enum": [ "default", "on", "off", "on-force", "off-force", "default-force" ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "emailDomain": { "type": "string", "nullable": true } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "deletedCount", "inviteIds" ], "properties": { "deletedCount": { "type": "number" }, "inviteIds": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "directoryType": { "type": "string" }, "ssoType": { "type": "string" }, "invitedUser": { "type": "object", "required": [ "email", "username" ], "properties": { "username": { "type": "string" }, "email": { "type": "string" } } }, "invitedEmail": { "type": "string" }, "invitationRole": { "type": "string" }, "entitlements": { "type": "array", "items": { "type": "string" } }, "invitedUid": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "teamName" ], "properties": { "teamName": { "type": "string" }, "username": { "type": "string" }, "gitUsername": { "type": "string" }, "githubUsername": { "type": "string", "nullable": true }, "gitlabUsername": { "type": "string", "nullable": true }, "bitbucketUsername": { "type": "string", "nullable": true }, "updatedUid": { "type": "string" }, "teamId": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "teamName" ], "properties": { "teamName": { "type": "string" }, "username": { "type": "string" }, "gitUsername": { "type": "string", "nullable": true }, "githubUsername": { "type": "string", "nullable": true }, "gitlabUsername": { "type": "string", "nullable": true }, "bitbucketUsername": { "type": "string", "nullable": true } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "deletedUser": { "type": "object", "required": [ "email", "username" ], "properties": { "username": { "type": "string" }, "email": { "type": "string" } } }, "deletedUid": { "type": "string" }, "githubUsername": { "type": "string", "nullable": true }, "gitlabUsername": { "type": "string", "nullable": true }, "bitbucketUsername": { "type": "string", "nullable": true }, "directoryType": { "type": "string" }, "role": { "type": "string", "enum": [ "OWNER", "MEMBER", "DEVELOPER", "SECURITY", "BILLING", "VIEWER", "VIEWER_FOR_PLUS", "CONTRIBUTOR" ] }, "reason": { "type": "string", "description": "Why the member was removed. When removed due to a plan downgrade, this is a {@link DowngradeReason} from `@api/pubsub-types` (e.g. `trial_expired`, `user_downgrade`)." }, "previousPlan": { "type": "string", "enum": [ "pro", "enterprise", "hobby" ] }, "newPlan": { "type": "string", "enum": [ "pro", "enterprise", "hobby" ] }, "automated": { "type": "boolean", "description": "Whether the removal was system-initiated rather than human-initiated.", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "entitlement", "user" ], "properties": { "entitlement": { "type": "string" }, "user": { "type": "object", "required": [ "id", "username" ], "properties": { "id": { "type": "string" }, "username": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "entitlement", "user" ], "properties": { "entitlement": { "type": "string" }, "user": { "type": "object", "required": [ "id", "username" ], "properties": { "id": { "type": "string" }, "username": { "type": "string" } } }, "previousCanceledAt": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "uid" ], "properties": { "role": { "type": "string" }, "uid": { "type": "string" }, "origin": { "type": "string" }, "teamRoles": { "type": "array", "items": { "type": "string" } }, "teamPermissions": { "type": "array", "items": { "type": "string" } }, "entitlements": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "requestedTeamName" ], "properties": { "requestedTeamName": { "type": "string" }, "requestedUserName": { "type": "string" }, "gitUsername": { "type": "string" }, "githubUsername": { "type": "string" }, "gitlabUsername": { "type": "string" }, "bitbucketUsername": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "previousRole" ], "properties": { "directoryType": { "type": "string" }, "updatedUser": { "type": "object", "required": [ "email", "username" ], "properties": { "username": { "type": "string" }, "email": { "type": "string" } } }, "role": { "type": "string" }, "previousRole": { "type": "string" }, "updatedUid": { "type": "string" }, "origin": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "enforced" ], "properties": { "enforced": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "nextConcurrentBuilds", "previousConcurrentBuilds" ], "properties": { "previousConcurrentBuilds": { "type": "number" }, "nextConcurrentBuilds": { "type": "number" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "plan" ], "properties": { "plan": { "type": "string", "enum": [ "pro", "enterprise", "hobby" ] }, "trial": { "type": "object", "nullable": true, "required": [ "end", "start" ], "properties": { "start": { "type": "number" }, "end": { "type": "number" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "convertedFromTrial", "invoiceId", "plan" ], "properties": { "invoiceId": { "type": "string" }, "convertedFromTrial": { "type": "boolean", "enum": [ false, true ] }, "plan": { "type": "string", "enum": [ "pro", "enterprise", "hobby" ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "inviteCode": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "name": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "consent" ], "properties": { "consent": { "type": "string", "enum": [ "granted", "refused" ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "remoteCaching": { "type": "object", "description": "Represents configuration for remote caching", "properties": { "enabled": { "type": "boolean", "enum": [ false, true ] } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "enabled" ], "properties": { "enabled": { "type": "string", "enum": [ "default", "on", "off" ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "enabled", "scope" ], "properties": { "enabled": { "type": "boolean", "enum": [ false, true ] }, "scope": { "type": "string", "enum": [ "dashboard", "log-drains" ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "previous": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "object", "required": [ "accessGroupId" ], "properties": { "accessGroupId": { "type": "string" } } }, { "type": "string", "enum": [ "OWNER", "MEMBER", "DEVELOPER", "SECURITY", "BILLING", "VIEWER", "VIEWER_FOR_PLUS", "CONTRIBUTOR" ] } ] } }, "next": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "object", "required": [ "accessGroupId" ], "properties": { "accessGroupId": { "type": "string" } } }, { "type": "string", "enum": [ "OWNER", "MEMBER", "DEVELOPER", "SECURITY", "BILLING", "VIEWER", "VIEWER_FOR_PLUS", "CONTRIBUTOR" ] } ] } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "domain", "ips" ], "properties": { "domain": { "type": "string" }, "ips": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "exportId", "format", "from", "to" ], "properties": { "exportId": { "type": "string" }, "from": { "type": "number" }, "to": { "type": "number" }, "format": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "fileId" ], "properties": { "fileId": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "properties": { "slug": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "login", "provider" ], "properties": { "provider": { "type": "string", "enum": [ "github", "github-limited", "github-custom-host", "gitlab", "bitbucket", "google", "apple", "chatgpt" ] }, "login": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "recoveryCodes", "totp" ], "properties": { "totp": { "type": "boolean", "enum": [ false, true ] }, "recoveryCodes": { "type": "number" }, "actorId": { "type": "string" }, "actorType": { "type": "string", "enum": [ "user", "admin" ] }, "reason": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "username" ], "properties": { "deletedAt": { "type": "number", "nullable": true }, "username": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "next", "previous" ], "properties": { "previous": { "type": "object", "required": [ "enabled", "totpVerified" ], "properties": { "enabled": { "type": "boolean", "enum": [ false, true ] }, "totpVerified": { "type": "boolean", "enum": [ false, true ] } } }, "next": { "type": "object", "required": [ "enabled", "totpVerified" ], "properties": { "enabled": { "type": "boolean", "enum": [ false, true ] }, "totpVerified": { "type": "boolean", "enum": [ false, true ] } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "mfaEnabled" ], "properties": { "mfaEnabled": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "enabled", "totpVerified" ], "properties": { "enabled": { "type": "boolean", "enum": [ false, true ] }, "totpVerified": { "type": "boolean", "enum": [ false, true ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "email", "prevEmail" ], "properties": { "email": { "type": "string" }, "prevEmail": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "username" ], "properties": { "username": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "ruleName" ], "properties": { "ruleName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "configuration", "peering", "team" ], "properties": { "team": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "configuration": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "peering": { "type": "object", "required": [ "accountId", "id", "region", "vpcId" ], "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "region": { "type": "string" }, "vpcId": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "configuration", "peering", "team" ], "properties": { "team": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "configuration": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "peering": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "configuration", "peering", "team" ], "properties": { "team": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "configuration": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "peering": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "newName": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "tier" ], "properties": { "tier": { "type": "string", "enum": [ "pro", "plus" ] } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "id", "url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "chatId" ], "properties": { "chatId": { "type": "string" }, "chatTitle": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "model", "useCase" ], "properties": { "model": { "type": "string" }, "useCase": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "chatId", "messageId" ], "properties": { "chatId": { "type": "string" }, "chatTitle": { "type": "string" }, "messageId": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "deploymentId", "projectId", "runId" ], "properties": { "deploymentId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" } } }, { "type": "object", "description": "The payload of the event, if requested.", "required": [ "appName", "atTTL", "authMethod", "grantType", "scope" ], "properties": { "grantType": { "type": "string", "enum": [ "authorization_code", "urn:ietf:params:oauth:grant-type:device_code" ] }, "appName": { "type": "string", "description": "the app's name at the time the event was published (it could have changed since then)" }, "atTTL": { "type": "number", "description": "access_token TTL" }, "rtTTL": { "type": "number", "description": "refresh_token TTL" }, "scope": { "type": "string" }, "authMethod": { "type": "string", "enum": [ "email", "saml", "app", "github", "gitlab", "bitbucket", "google", "apple", "chatgpt", "github-webhook", "manual", "passkey", "otp", "sms", "invite", "emu" ] }, "app": { "type": "object", "description": "optional since entries prior to 2025-10-13 do not contain app information", "required": [ "clientAuthenticationUsed", "clientId", "name" ], "properties": { "clientId": { "type": "string" }, "name": { "type": "string", "description": "the app's name at the time the event was published (it could have changed since then)" }, "clientAuthenticationUsed": { "type": "object", "required": [ "method" ], "properties": { "method": { "type": "string", "enum": [ "client_secret_basic", "client_secret_post", "client_secret_jwt", "private_key_jwt", "oidc_token", "none" ] }, "secretId": { "type": "string" } } } } }, "includesRefreshToken": { "type": "boolean", "description": "optional since entries prior to 2025-10-13 do not contain this field", "enum": [ false, true ] }, "publicId": { "type": "string", "description": "optional since entries prior to 2025-10-13 do not contain this field" }, "sessionId": { "type": "string", "description": "optional since entries prior to 2025-10-13 do not contain this field" } } } ] } } } } } } ] } ``` ### 400: One of the provided values in the request query is invalid. ### 401: The request is not authorized. ### 403: You do not have permission to access this resource. --- ## Related - [user endpoints](/docs/rest-api#user) - [REST API overview](/docs/rest-api) - [OpenAPI spec](https://openapi.vercel.sh/) (machine-readable, all endpoints) --- [View full sitemap](/docs/sitemap)