projectEvents

Subscribe to events within a specific project via WebSocket.

Receives events for the project itself, its environments, and its blueprint (components and links). Requires read access to the project.

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

projectEvents(
  organizationId: ID!
  projectId: ID!
): ProjectEventsPayload

Arguments

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

Your organization's unique identifier.

projectEvents.projectId ● ID! non-null scalar {#project-id}

The identifier of the project to subscribe to.

Type

ProjectEventsPayload union

Events delivered by the projectEvents subscription.

Covers the project itself plus its blueprint (components, links) and the environments provisioned from it.