Skip to content
Install

Server-sent events stream of org changes, scoped to projects the caller can see; each SSE message data field is one JSON event, resumable via Last-Event-ID

GET
/events/orgs/{orgId}
curl --request GET \
--url https://example.com/events/orgs/example \
--header 'Authorization: Bearer <token>'

Auth: authenticated

orgId
required
string
lastEventId

Resume after this event id (Redis stream id); the Last-Event-ID header takes precedence

string

Resume after this event id (Redis stream id); the Last-Event-ID header takes precedence

OK

Media typeapplication/json

The JSON-decoded data field of one SSE message on the org event stream

Any of:
object
id

The changed entity id (deployment, database, job, run, environment, …); the affected user id for membership.changed

string
organizationId
required
string
payload

Event-specific payload: structured for jobrun.changed, deployment.metrics, audit.created and build.changed, informer-derived data for pod.changed and database.changed, absent otherwise

Any of:

Payload for jobrun.changed events

object
currentStepOrder
required
integer | null
jobId
required
string
number
required
integer
runId
required
string
status
required
string
key
additional properties
projectId
string
ts
required

Emit time, Unix epoch milliseconds

number
type
required
string
Allowed values: deployment.changed database.changed build.changed project.changed pod.changed membership.changed deployment.metrics job.changed jobrun.changed environment.changed sharedvars.changed engine.changed audit.created
key
additional properties

Example

{
"type": "deployment.changed"
}