Skip to main content

DeploymentEvent

A lifecycle event for a deployment.

Emitted when a deployment is created (CREATED) and each time its status transitions (UPDATED) — e.g., PENDINGRUNNINGCOMPLETED. Log deltas are not carried on this event; subscribe to deploymentLogs for streaming log content.

Subscribe via deploymentEvents for a single deployment's feed, or via instanceEvents / environmentEvents to see every deployment in an instance or environment.

On UPDATED, re-select whichever fields you need (typically status and elapsedTime) — Apollo will merge the payload into its cache by Deployment:id.

type DeploymentEvent implements Event {
action: EventAction!
timestamp: DateTime!
deployment: Deployment!
}

Fields

DeploymentEvent.action ● EventAction! non-null enum {#action}

DeploymentEvent.timestamp ● DateTime! non-null scalar {#timestamp}

DeploymentEvent.deployment ● Deployment! non-null object {#deployment}

The deployment that was created or updated.

Interfaces

Event interface

Base interface implemented by all lifecycle events.

Every event carries an action describing what happened and a timestamp recording when it occurred. Concrete event types add a field for the affected resource.

Because each subscription returns a union, use an ... on Event fragment to access the shared fields and concrete fragments for the resource payload:

subscription {
projectEvents(organizationId: "my-org", projectId: "my-project") {
... on Event { action timestamp }
... on ComponentEvent {
component { id name }
}
... on LinkEvent {
link { id fromField toField }
}
}
}

Implemented By

DeploymentEventsPayload union ● EnvironmentEventsPayload union ● InstanceEventsPayload union