Skip to main content
Server streaming · Events Streams events for all projects, runners, environments, tasks, and services based on the specified scope. Use this method to:
  • Monitor resource changes in real-time
  • Track system events
  • Receive notifications
The scope parameter determines which events to watch:
  • Organization scope (default): Watch all organization-wide events including projects, runners and environments. Task and service events are not included. Use by setting organization=true or omitting the scope.
  • Environment scope: Watch events for a specific environment, including its tasks, task executions, and services. Use by setting environment_id to the UUID of the environment to watch.

Endpoint

Send a Bearer token as described in Authentication. If your organization uses a custom management-plane domain, replace https://app.ona.com with that domain.

Request example

This is a streaming RPC. Use a Connect client so it can frame messages with application/connect+json or application/connect+proto. The JSON below is the unframed request message.

Request

gitpod.v1.WatchEventsRequest

Response

gitpod.v1.WatchEventsResponse
ResourceTypeFilter restricts which events are delivered for a specific resource type.gitpod.v1.WatchEventsRequest.ResourceTypeFilter