Stream Events

curl --request GET \
  --url https://api.tryreplicas.com/v1/replica/{id}/events \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "ts": "2023-11-07T05:31:56Z",
  "type": "<string>",
  "payload": {
    "version": "v1"
  }
}

Replica

Stream Events

Opens a Server-Sent Events (SSE) stream for real-time events from a replica. The connection remains open and events are pushed as they occur.

Each event is delivered as an SSE message in the format data: <JSON>\n\n. A heartbeat ping is sent every 15 seconds to keep the connection alive. Clients should reconnect automatically on disconnect.

All events share a common envelope structure with id (unique event ID), ts (ISO 8601 timestamp), type (event type discriminator), and payload (type-specific data). See the EngineEvent schema for all possible event types.

GET

replica

{id}

events

Stream Events

curl --request GET \
  --url https://api.tryreplicas.com/v1/replica/{id}/events \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "ts": "2023-11-07T05:31:56Z",
  "type": "<string>",
  "payload": {
    "version": "v1"
  }
}

Authorizations

Authorization

string

header

required

API key authentication. Obtain your API key from the Replicas dashboard under Settings > API Keys.

Path Parameters

string<uuid>

required

The unique identifier of the replica

Response

SSE event stream opened successfully. Each line is a JSON-encoded EngineEvent.

Engine initialization complete.

string

required

Unique event ID

string<date-time>

required

ISO 8601 timestamp

type

string

required

Allowed value: "engine.ready"

payload

object

required

Show child attributes

Get Hook Logs

List Automations

Replica

Documentation Index

Authorizations

Path Parameters

Response