API Reference

Events

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

WatchEvents

client.Events.Watch(ctx, body) (*EventWatchResponse, error)

POST/gitpod.v1.EventService/WatchEvents

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.

ParametersExpand Collapse

body EventWatchParams

EnvironmentID param.Field[string]Optional

Environment scope produces events for the environment itself, all tasks, task executions, and services associated with that environment.

Organization param.Field[bool]Optional

Organization scope produces events for all projects, runners and environments the caller can see within their organization. No task, task execution or service events are produed.

ResourceTypeFilters param.Field[[]EventWatchParamsResourceTypeFilter]Optional

Filters to limit which events are delivered on organization-scoped streams. When empty, all events for the scope are delivered. When populated, only events matching at least one filter entry are forwarded. Not supported for environment-scoped streams; setting this field returns an error.

CreatorIDs []stringOptional

If non-empty, only events where the resource was created by one of these user IDs are delivered. Skipped for DELETE operations (creator info is unavailable after deletion). Events with no creator information are skipped when this filter is set (fail-closed).

ResourceIDs []stringOptional

If non-empty, only events for these specific resource IDs are delivered.

ResourceType ResourceTypeOptional

The resource type to filter for.

One of the following:

const ResourceTypeUnspecified ResourceType = "RESOURCE_TYPE_UNSPECIFIED"

const ResourceTypeEnvironment ResourceType = "RESOURCE_TYPE_ENVIRONMENT"

const ResourceTypeRunner ResourceType = "RESOURCE_TYPE_RUNNER"

const ResourceTypeProject ResourceType = "RESOURCE_TYPE_PROJECT"

const ResourceTypeTask ResourceType = "RESOURCE_TYPE_TASK"

const ResourceTypeTaskExecution ResourceType = "RESOURCE_TYPE_TASK_EXECUTION"

const ResourceTypeService ResourceType = "RESOURCE_TYPE_SERVICE"

const ResourceTypeOrganization ResourceType = "RESOURCE_TYPE_ORGANIZATION"

const ResourceTypeUser ResourceType = "RESOURCE_TYPE_USER"

const ResourceTypeEnvironmentClass ResourceType = "RESOURCE_TYPE_ENVIRONMENT_CLASS"

const ResourceTypeRunnerScmIntegration ResourceType = "RESOURCE_TYPE_RUNNER_SCM_INTEGRATION"

const ResourceTypeHostAuthenticationToken ResourceType = "RESOURCE_TYPE_HOST_AUTHENTICATION_TOKEN"

const ResourceTypeGroup ResourceType = "RESOURCE_TYPE_GROUP"

const ResourceTypePersonalAccessToken ResourceType = "RESOURCE_TYPE_PERSONAL_ACCESS_TOKEN"

const ResourceTypeUserPreference ResourceType = "RESOURCE_TYPE_USER_PREFERENCE"

const ResourceTypeServiceAccount ResourceType = "RESOURCE_TYPE_SERVICE_ACCOUNT"

const ResourceTypeSecret ResourceType = "RESOURCE_TYPE_SECRET"

const ResourceTypeSSOConfig ResourceType = "RESOURCE_TYPE_SSO_CONFIG"

const ResourceTypeDomainVerification ResourceType = "RESOURCE_TYPE_DOMAIN_VERIFICATION"

const ResourceTypeAgentExecution ResourceType = "RESOURCE_TYPE_AGENT_EXECUTION"

const ResourceTypeRunnerLlmIntegration ResourceType = "RESOURCE_TYPE_RUNNER_LLM_INTEGRATION"

const ResourceTypeAgent ResourceType = "RESOURCE_TYPE_AGENT"

const ResourceTypeEnvironmentSession ResourceType = "RESOURCE_TYPE_ENVIRONMENT_SESSION"

const ResourceTypeUserSecret ResourceType = "RESOURCE_TYPE_USER_SECRET"

const ResourceTypeOrganizationPolicy ResourceType = "RESOURCE_TYPE_ORGANIZATION_POLICY"

const ResourceTypeOrganizationSecret ResourceType = "RESOURCE_TYPE_ORGANIZATION_SECRET"

const ResourceTypeProjectEnvironmentClass ResourceType = "RESOURCE_TYPE_PROJECT_ENVIRONMENT_CLASS"

const ResourceTypeBilling ResourceType = "RESOURCE_TYPE_BILLING"

const ResourceTypePrompt ResourceType = "RESOURCE_TYPE_PROMPT"

const ResourceTypeCoupon ResourceType = "RESOURCE_TYPE_COUPON"

const ResourceTypeCouponRedemption ResourceType = "RESOURCE_TYPE_COUPON_REDEMPTION"

const ResourceTypeAccount ResourceType = "RESOURCE_TYPE_ACCOUNT"

const ResourceTypeIntegration ResourceType = "RESOURCE_TYPE_INTEGRATION"

const ResourceTypeWorkflow ResourceType = "RESOURCE_TYPE_WORKFLOW"

const ResourceTypeWorkflowExecution ResourceType = "RESOURCE_TYPE_WORKFLOW_EXECUTION"

const ResourceTypeWorkflowExecutionAction ResourceType = "RESOURCE_TYPE_WORKFLOW_EXECUTION_ACTION"

const ResourceTypeSnapshot ResourceType = "RESOURCE_TYPE_SNAPSHOT"

const ResourceTypePrebuild ResourceType = "RESOURCE_TYPE_PREBUILD"

const ResourceTypeOrganizationLlmIntegration ResourceType = "RESOURCE_TYPE_ORGANIZATION_LLM_INTEGRATION"

const ResourceTypeCustomDomain ResourceType = "RESOURCE_TYPE_CUSTOM_DOMAIN"

const ResourceTypeRoleAssignmentChanged ResourceType = "RESOURCE_TYPE_ROLE_ASSIGNMENT_CHANGED"

const ResourceTypeGroupMembershipChanged ResourceType = "RESOURCE_TYPE_GROUP_MEMBERSHIP_CHANGED"

const ResourceTypeWebhook ResourceType = "RESOURCE_TYPE_WEBHOOK"

const ResourceTypeScimConfiguration ResourceType = "RESOURCE_TYPE_SCIM_CONFIGURATION"

const ResourceTypeServiceAccountSecret ResourceType = "RESOURCE_TYPE_SERVICE_ACCOUNT_SECRET"

const ResourceTypeAnnouncementBanner ResourceType = "RESOURCE_TYPE_ANNOUNCEMENT_BANNER"

const ResourceTypeServiceAccountToken ResourceType = "RESOURCE_TYPE_SERVICE_ACCOUNT_TOKEN"

const ResourceTypeRoleAssignment ResourceType = "RESOURCE_TYPE_ROLE_ASSIGNMENT"

const ResourceTypeWarmPool ResourceType = "RESOURCE_TYPE_WARM_POOL"

const ResourceTypeNotification ResourceType = "RESOURCE_TYPE_NOTIFICATION"

ReturnsExpand Collapse

type EventWatchResponse struct{…}

Operation ResourceOperationOptional

One of the following:

const ResourceOperationUnspecified ResourceOperation = "RESOURCE_OPERATION_UNSPECIFIED"

const ResourceOperationCreate ResourceOperation = "RESOURCE_OPERATION_CREATE"

const ResourceOperationUpdate ResourceOperation = "RESOURCE_OPERATION_UPDATE"

const ResourceOperationDelete ResourceOperation = "RESOURCE_OPERATION_DELETE"

const ResourceOperationUpdateStatus ResourceOperation = "RESOURCE_OPERATION_UPDATE_STATUS"

ResourceID stringOptional

formatuuid

ResourceType ResourceTypeOptional

One of the following:

const ResourceTypeUnspecified ResourceType = "RESOURCE_TYPE_UNSPECIFIED"

const ResourceTypeEnvironment ResourceType = "RESOURCE_TYPE_ENVIRONMENT"

const ResourceTypeRunner ResourceType = "RESOURCE_TYPE_RUNNER"

const ResourceTypeProject ResourceType = "RESOURCE_TYPE_PROJECT"

const ResourceTypeTask ResourceType = "RESOURCE_TYPE_TASK"

const ResourceTypeTaskExecution ResourceType = "RESOURCE_TYPE_TASK_EXECUTION"

const ResourceTypeService ResourceType = "RESOURCE_TYPE_SERVICE"

const ResourceTypeOrganization ResourceType = "RESOURCE_TYPE_ORGANIZATION"

const ResourceTypeUser ResourceType = "RESOURCE_TYPE_USER"

const ResourceTypeEnvironmentClass ResourceType = "RESOURCE_TYPE_ENVIRONMENT_CLASS"

const ResourceTypeRunnerScmIntegration ResourceType = "RESOURCE_TYPE_RUNNER_SCM_INTEGRATION"

const ResourceTypeHostAuthenticationToken ResourceType = "RESOURCE_TYPE_HOST_AUTHENTICATION_TOKEN"

const ResourceTypeGroup ResourceType = "RESOURCE_TYPE_GROUP"

const ResourceTypePersonalAccessToken ResourceType = "RESOURCE_TYPE_PERSONAL_ACCESS_TOKEN"

const ResourceTypeUserPreference ResourceType = "RESOURCE_TYPE_USER_PREFERENCE"

const ResourceTypeServiceAccount ResourceType = "RESOURCE_TYPE_SERVICE_ACCOUNT"

const ResourceTypeSecret ResourceType = "RESOURCE_TYPE_SECRET"

const ResourceTypeSSOConfig ResourceType = "RESOURCE_TYPE_SSO_CONFIG"

const ResourceTypeDomainVerification ResourceType = "RESOURCE_TYPE_DOMAIN_VERIFICATION"

const ResourceTypeAgentExecution ResourceType = "RESOURCE_TYPE_AGENT_EXECUTION"

const ResourceTypeRunnerLlmIntegration ResourceType = "RESOURCE_TYPE_RUNNER_LLM_INTEGRATION"

const ResourceTypeAgent ResourceType = "RESOURCE_TYPE_AGENT"

const ResourceTypeEnvironmentSession ResourceType = "RESOURCE_TYPE_ENVIRONMENT_SESSION"

const ResourceTypeUserSecret ResourceType = "RESOURCE_TYPE_USER_SECRET"

const ResourceTypeOrganizationPolicy ResourceType = "RESOURCE_TYPE_ORGANIZATION_POLICY"

const ResourceTypeOrganizationSecret ResourceType = "RESOURCE_TYPE_ORGANIZATION_SECRET"

const ResourceTypeProjectEnvironmentClass ResourceType = "RESOURCE_TYPE_PROJECT_ENVIRONMENT_CLASS"

const ResourceTypeBilling ResourceType = "RESOURCE_TYPE_BILLING"

const ResourceTypePrompt ResourceType = "RESOURCE_TYPE_PROMPT"

const ResourceTypeCoupon ResourceType = "RESOURCE_TYPE_COUPON"

const ResourceTypeCouponRedemption ResourceType = "RESOURCE_TYPE_COUPON_REDEMPTION"

const ResourceTypeAccount ResourceType = "RESOURCE_TYPE_ACCOUNT"

const ResourceTypeIntegration ResourceType = "RESOURCE_TYPE_INTEGRATION"

const ResourceTypeWorkflow ResourceType = "RESOURCE_TYPE_WORKFLOW"

const ResourceTypeWorkflowExecution ResourceType = "RESOURCE_TYPE_WORKFLOW_EXECUTION"

const ResourceTypeWorkflowExecutionAction ResourceType = "RESOURCE_TYPE_WORKFLOW_EXECUTION_ACTION"

const ResourceTypeSnapshot ResourceType = "RESOURCE_TYPE_SNAPSHOT"

const ResourceTypePrebuild ResourceType = "RESOURCE_TYPE_PREBUILD"

const ResourceTypeOrganizationLlmIntegration ResourceType = "RESOURCE_TYPE_ORGANIZATION_LLM_INTEGRATION"

const ResourceTypeCustomDomain ResourceType = "RESOURCE_TYPE_CUSTOM_DOMAIN"

const ResourceTypeRoleAssignmentChanged ResourceType = "RESOURCE_TYPE_ROLE_ASSIGNMENT_CHANGED"

const ResourceTypeGroupMembershipChanged ResourceType = "RESOURCE_TYPE_GROUP_MEMBERSHIP_CHANGED"

const ResourceTypeWebhook ResourceType = "RESOURCE_TYPE_WEBHOOK"

const ResourceTypeScimConfiguration ResourceType = "RESOURCE_TYPE_SCIM_CONFIGURATION"

const ResourceTypeServiceAccountSecret ResourceType = "RESOURCE_TYPE_SERVICE_ACCOUNT_SECRET"

const ResourceTypeAnnouncementBanner ResourceType = "RESOURCE_TYPE_ANNOUNCEMENT_BANNER"

const ResourceTypeServiceAccountToken ResourceType = "RESOURCE_TYPE_SERVICE_ACCOUNT_TOKEN"

const ResourceTypeRoleAssignment ResourceType = "RESOURCE_TYPE_ROLE_ASSIGNMENT"

const ResourceTypeWarmPool ResourceType = "RESOURCE_TYPE_WARM_POOL"

const ResourceTypeNotification ResourceType = "RESOURCE_TYPE_NOTIFICATION"

WatchEvents

Go

HTTP

TypeScript

Python

Go

package main

import (
  "context"
  "fmt"

  "github.com/gitpod-io/gitpod-sdk-go"
  "github.com/gitpod-io/gitpod-sdk-go/option"
)

func main() {
  client := gitpod.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  stream := client.Events.WatchStreaming(context.TODO(), gitpod.EventWatchParams{

  })
  for stream.Next() {
  fmt.Printf("%+v\n", stream.Current())
  }
  err := stream.Err()
  if err != nil {
    panic(err.Error())
  }
}

Returns Examples