environmentEvents

Subscribe to events within a specific environment via WebSocket.

Receives updates and deletions for the environment itself, plus creation and deletion of realized connections within that environment. Environment creation events are delivered via projectEvents (the environment must exist before you can subscribe to it).

subscription {
  environmentEvents(organizationId: "my-org", environmentId: "my-project-prod") {
    action
    timestamp
    ... on EnvironmentEvent {
      environment { id name }
    }
    ... on ConnectionEvent {
      connection { id fromField toField }
    }
  }
}

environmentEvents(
  organizationId: ID!
  environmentId: ID!
): Event

Arguments

environmentEvents.organizationId ● ID! non-null scalar {#organization-id}

Your organization's unique identifier.

environmentEvents.environmentId ● ID! non-null scalar {#environment-id}

The identifier of the environment to subscribe to.

Type

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.

Use inline fragments to access the resource-specific fields:

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