Get Deployment Event Stream

Beta
Opens a server-sent events (SSE) stream that delivers real-time deployment progress updates. The stream remains open until the deployment completes, fails, or the connection times out (30 seconds). Each event is a JSON object delivered as an SSE `data` field. Parse the `data` value as JSON before reading the fields below. ### Event payload | Field | Type | Description | |---|---|---| | `deployment_uuid` | string | The UUID of the deployment the event belongs to. | | `deployment_status` | string | One of `queued`, `in_progress`, `failed`, or `completed`. | | `event` | object or null | The current step and progress. `null` when no step information is available yet. | | `event.step` | string | One of `initializing`, `downloading`, `unzipping`, `processing`, `deploying`, `finalizing`, or `complete`. | | `event.progress` | integer | Percentage complete, from 0 to 100. | | `error` | object | Present only when `deployment_status` is `failed`. Contains a numeric `code`. | | `deployment_hostnames` | array of strings | Hostnames serving the deployment. Always present, but empty (`[]`) until the deployment reaches `finalizing`. Prefix the first entry with `https://` to build the deployment URL. | Not every step appears in every deployment, so drive any progress display from the `event.step` and `event.progress` values as they arrive rather than expecting a fixed sequence. ### Deployment error codes When `deployment_status` is `failed`, `error.code` identifies the failure reason: | Code | Meaning | What to do | |---|---|---| | `10` | An internal error occurred while processing the deployment. | Retry the deployment. If it keeps failing, contact support. | | `20` | The uploaded bundle could not be retrieved. | Usually transient — retry the deployment. | | `30` | The bundle could not be extracted. | The archive is corrupted, or the build output exceeds the size limits (64 MB compressed, 512 MB uncompressed). Reduce your build size or rebuild and redeploy. | | `40` | The build output is invalid. | Check that `worker.js` is 64 MB or smaller, that no individual asset exceeds 25 MB, and that the bundle contains no more than 1,000 files. | | `50` | The deployment step failed. | Usually transient — retry the deployment. If it persists, contact support. | | `60` | The code deployed, but the deployment URL could not be determined. | Retry the deployment. If it persists, contact support. | Treat any other code as an unexpected failure: retry the deployment, and contact support if it persists.

Authentication

X-Auth-Tokenstring
### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Infrastructure Deployments | read-only | `store_infrastructure_deployments_read_only` | | Infrastructure Deployments | create preview | `store_infrastructure_deployments_create_preview` | | Infrastructure Deployments | manage | `store_infrastructure_deployments_manage` | | Infrastructure Projects | read-only | `store_infrastructure_projects_read_only` | | Infrastructure Projects | manage | `store_infrastructure_projects_manage` | | Infrastructure Logs | read-only | `store_infrastructure_logs_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Path parameters

deployment_uuidstringRequiredformat: "uuid"
The UUID of the deployment to stream events for.
store_hashstringRequired
Permanent ID of the BigCommerce store.

Response

A stream of server-sent events with deployment progress updates. The data attribute is stringified JSON.

Errors

400
Bad Request Error