> This page is for Developer.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.bigcommerce.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server.

# Get Deployment Event Stream

GET https://api.bigcommerce.com/stores/{store_hash}/v3/infrastructure/deployments/{deployment_uuid}/events

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  | The current step and progress. Omitted 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`.                              |

If the deployment cannot be found after the stream opens, the stream delivers a single event whose `data` is `{"error": "The requested deployment was not found."}` and then closes.
\| `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.

Reference: https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/infrastructure-hosting/deployments/get-deployment-event-stream

## Authentication

- `X-Auth-Token` header (required) — ### 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).

## Request

### Path parameters

- `deployment_uuid` (string, required) — The UUID of the deployment to stream events for.
- `store_hash` (string, required) — Permanent ID of the BigCommerce store.

## Response

### 200

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

- Streaming response of `DeploymentEvent`.
- `deployment_uuid` (string, required) — The UUID of the deployment.
- `deployment_status` (enum, required) — The current status of the deployment.
  - Allowed values: `queued`, `in_progress`, `failed`, `completed`
- `deployment_hostnames` (list of string, required) — The hostnames serving the deployment. Always present, but empty until the deployment reaches `finalizing`. Prefix the first entry with `https://` to build the deployment URL.
- `event` (DeploymentEventEvent, optional) — Details about the current deployment step and progress. Omitted when no step information is available yet.
- `error` (DeploymentEventError, optional) — Error information if the deployment failed. Present only when `deployment_status` is `failed`.

## Errors

### 400 Bad Request Error

The deployment UUID is not a valid UUID.

- `status` (integer, optional) — The HTTP status code.
- `title` (string, optional) — A description of the error.
- `type` (string, optional) — A URL identifying the error type.
- `errors` (ErrorResponseErrors, optional) — Additional error details.
- `meta` (map from string to any, optional) — Additional structured context for the error, such as the ownership-verification TXT record to publish, the conflicting `project_uuid`, or the domain `limit` and `current` count.

## Types

### DeploymentEventEvent

Details about the current deployment step and progress. Omitted when no step information is available yet.

- `step` (enum, optional) — The current step in the deployment process.
  - Allowed values: `initializing`, `downloading`, `unzipping`, `processing`, `deploying`, `finalizing`, `complete`
- `progress` (integer, optional) — The progress percentage of the deployment.

### DeploymentEventError

Error information if the deployment failed. Present only when `deployment_status` is `failed`.

- `code` (enum, optional) — An error code identifying the failure reason. Treat any other code as an unexpected failure. - `10`: An internal error occurred while processing the deployment. - `20`: The uploaded bundle could not be retrieved. - `30`: The bundle could not be extracted, either because the archive is corrupted or because the build output exceeds the size limits (64 MB compressed, 512 MB uncompressed). - `40`: The build output is invalid: `worker.js` exceeds 64 MB, an individual asset exceeds 25 MB, or the bundle contains more than 1,000 files. - `50`: The deployment step failed. - `60`: The code deployed, but the deployment URL could not be determined.
  - Allowed values: `10`, `20`, `30`, `40`, `50`, `60`

### ErrorResponseErrors

Additional error details.

## Examples

**SDK Code**

```python
import requests

url = "https://api.bigcommerce.com/stores/store_hash/v3/infrastructure/deployments/deployment_uuid/events"

headers = {"X-Auth-Token": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.bigcommerce.com/stores/store_hash/v3/infrastructure/deployments/deployment_uuid/events';
const options = {method: 'GET', headers: {'X-Auth-Token': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bigcommerce.com/stores/store_hash/v3/infrastructure/deployments/deployment_uuid/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Auth-Token", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.bigcommerce.com/stores/store_hash/v3/infrastructure/deployments/deployment_uuid/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Auth-Token"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.bigcommerce.com/stores/store_hash/v3/infrastructure/deployments/deployment_uuid/events")
  .header("X-Auth-Token", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.bigcommerce.com/stores/store_hash/v3/infrastructure/deployments/deployment_uuid/events', [
  'headers' => [
    'X-Auth-Token' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.bigcommerce.com/stores/store_hash/v3/infrastructure/deployments/deployment_uuid/events");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Auth-Token", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-Auth-Token": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bigcommerce.com/stores/store_hash/v3/infrastructure/deployments/deployment_uuid/events")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```