InstanceEvent

A lifecycle event for an instance.

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

type InstanceEvent implements Event {
  action: EventAction!
  timestamp: DateTime!
  instance: Instance!
}

Fields

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

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

InstanceEvent.instance ● Instance! non-null object {#instance}

The instance that was created, updated, or deleted.

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

EnvironmentEventsPayload union ● InstanceEventsPayload union