Skip to content

SDK: events

The events methods of the Overlane TypeScript SDK, with their signatures. Generated from the SDK types.

Updated View as MarkdownOpen in ChatGPTOpen in Claude

The events area has 2 methods on the client. Each takes one object of path, query and body arguments and an optional CallOptions, and returns a promise of the response body. A refused call rejects with OverlaneApiError (see the SDK index).

eventsList

A project’s domain events

  • Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/events
eventsList(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<Record<string, unknown>>

eventsStream

A project’s domain events as a server-sent event stream: replays from since (or the Last-Event-ID header) in sequence order, then streams live with a heartbeat; the stream ends after a few minutes and the reader reconnects with its last id

  • Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/events/stream
eventsStream(args: { tenantId: string; projectId: string; query?: { since?: string } }, options?: CallOptions): Promise<Record<string, unknown>>
Navigation

Type to search…

↑↓ navigate↵ selectEsc close

Overlane Agent

Ask about the docs. Answers are quoted from the pages, with links. This panel cannot change anything.

    Questions are answered in your browser from the docs index. Nothing you type here is stored or sent anywhere.