Deployment data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for the deployment |
created_at | string (date-time) | No | When the deployment was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the deployment was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
service_id | string | No | The service this deployment belongs to |
status | enum | No | Normalized deployment status; set to CANCELED on update to cancel Values: QUEUED, BUILDING, DEPLOYING, LIVE, FAILED, CANCELED, SUPERSEDED, OTHER |
trigger | enum | No | What started the deployment Values: GIT, MANUAL, API, ROLLBACK, OTHER |
environment | enum | No | Target environment Values: PRODUCTION, PREVIEW, DEVELOPMENT, OTHER |
commit_identifier | string | No | Source commit SHA (reference to RepoCommit) |
commit_message | string | No | Source commit message |
branch | string | No | Source branch |
image | string | No | Container image deployed, for image-based services |
url | string | No | URL where this deployment is served |
started_at | string (date-time) | No | When the build started (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
finished_at | string (date-time) | No | When the deployment finished (live, failed or canceled) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
error | string | No | Failure description |
metadata | ComputeMetadata[] | No | Vendor labels, tags and metadata |
metadata[].id | string | No | |
metadata[].slug | string | No | The label, tag or metadata key |
metadata[].value | object | No | The label, tag or metadata value |
metadata[].namespace | string | No | The origin of the value (eg. labels, tags, metadata) |
metadata[].format | enum | No | The data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT |
metadata[].extra_data | object | No |
Are we missing anything? Let us know