Skip to main content

InstanceEventsPayload

Events delivered by the instanceEvents subscription.

Covers the instance itself, incoming connections that terminate on it, alarms attached to it, and deployments run against it.

union InstanceEventsPayload = InstanceEvent | ConnectionEvent | AlarmEvent | DeploymentEvent

Possible types​

InstanceEventsPayload.InstanceEvent object​

A lifecycle event for an instance.

Emitted when an instance is created, updated (configuration changed, deployment triggered), or deleted. Subscribe via instanceEvents or projectEvents.

InstanceEventsPayload.ConnectionEvent object​

A lifecycle event for a realized connection between two instances in an environment.

A connection is the runtime materialization of a blueprint link — it wires one instance's output artifact into another instance's input field within a single environment. Emitted when a connection is established or torn down. Subscribe via environmentEvents for every connection in an environment, or via instanceEvents for connections that terminate on a specific instance.

InstanceEventsPayload.AlarmEvent object​

A lifecycle event for a cloud metric alarm attached to an instance.

Emitted when an alarm is registered, reconfigured, removed, or when its firing state changes (e.g., OK → ALARM). State transitions surface as UPDATED — read the latest status from alarm.currentState. Subscribe via environmentEvents or instanceEvents.

InstanceEventsPayload.DeploymentEvent object​

A lifecycle event for a deployment.

Emitted when a deployment is created (CREATED) and each time its status transitions (UPDATED) — e.g., PENDING → RUNNING → COMPLETED. 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.

Returned By​

instanceEvents subscription