---
title: "DeployWithSteps"
description: "The `DeployWithSteps` entity."
section: "Reference"
group: "Types"
order: 66
---

## Definition

```ts
interface DeployWithSteps {
  id: string;
  workspaceId: string;
  entityId: string;
  sequenceNumber: number;
  buildId: string | null;
  status: "pending" | "failed" | "running" | "completed" | "cancelled";
  trigger: "manual" | "auto" | "rollback";
  sourceEventId: string | null;
  productionUrl: string | null;
  previewUrl: string | null;
  error: string | null;
  metadata: Record<string, unknown> | null;
  createdBy: string | null;
  startedAt: string | null;
  completedAt: string | null;
  createdAt: string;
  steps: Array<{
    id: string;
    deployId: string;
    name: string;
    status: "pending" | "failed" | "running" | "completed" | "skipped";
    order: number;
    error: string | null;
    log: string | null;
    metadata: Record<string, unknown> | null;
    startedAt: string | null;
    completedAt: string | null;
    createdAt: string;
  }>;
}
```

## Fields

| Field            | Type                                                                                                                                                                                                                                                                                                              | Notes                                                               |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `id`             | `string`                                                                                                                                                                                                                                                                                                          | `readonly` `required`                                               |
| `workspaceId`    | `string`                                                                                                                                                                                                                                                                                                          | `required`                                                          |
| `entityId`       | `string`                                                                                                                                                                                                                                                                                                          | `required`                                                          |
| `sequenceNumber` | `number`                                                                                                                                                                                                                                                                                                          | `required`                                                          |
| `buildId`        | `string \| null`                                                                                                                                                                                                                                                                                                  | `required`                                                          |
| `status`         | `"pending" \| "failed" \| "running" \| "completed" \| "cancelled"`                                                                                                                                                                                                                                                | `required`                                                          |
| `trigger`        | `"manual" \| "auto" \| "rollback"`                                                                                                                                                                                                                                                                                | `required`                                                          |
| `sourceEventId`  | `string \| null`                                                                                                                                                                                                                                                                                                  | `required`                                                          |
| `productionUrl`  | `string \| null`                                                                                                                                                                                                                                                                                                  | `required`                                                          |
| `previewUrl`     | `string \| null`                                                                                                                                                                                                                                                                                                  | `required`                                                          |
| `error`          | `string \| null`                                                                                                                                                                                                                                                                                                  | `required`                                                          |
| `metadata`       | `Record<string, unknown> \| null`                                                                                                                                                                                                                                                                                 | `required`                                                          |
| `createdBy`      | `string \| null`                                                                                                                                                                                                                                                                                                  | `required`                                                          |
| `startedAt`      | `string \| null`                                                                                                                                                                                                                                                                                                  | `required`                                                          |
| `completedAt`    | `string \| null`                                                                                                                                                                                                                                                                                                  | `required`                                                          |
| `createdAt`      | `string`                                                                                                                                                                                                                                                                                                          | `readonly` `required`                                               |
| `steps`          | `Array<{ id: string; deployId: string; name: string; status: "pending" \| "failed" \| "running" \| "completed" \| "skipped"; order: number; error: string \| null; log: string \| null; metadata: Record<string, unknown> \| null; startedAt: string \| null; completedAt: string \| null; createdAt: string; }>` | `required` — Ordered list of steps executed as part of this deploy. |