Skip to main content
The WebSocket gateway lets your engine push signals with lower latency than HTTP webhooks. It uses the same JSON schema as inbound webhooks and the developer API.

​
Endpoint

Socket.IO namespace: /ws/signals

​
Authentication

Pass your developer API key in the Socket.IO handshake:
  • Header: x-api-key: ez_live_..., or
  • Auth payload: { "apiKey": "ez_live_..." }
Connection-level HMAC is not used on WebSocket. REST API-key requests require request signing; protect credentials in transit (TLS only). Invalid or missing keys receive an error event and disconnect.

​
Send a signal

Emit event signal with payload:
Structured #1098 payloads work the same as Signal envelope (include eventType, reasoning, idempotencyKey).

​
Responses

​
Rate limits

Connection inherits your API key rate limit tier (60/300/1000 req/min on REST; burst behavior on WebSocket is enforced server-side). Use idempotencyKey on every message.

​
Reconnect pattern

  1. Reconnect with the same API key
  2. Re-send unacknowledged signals with the same idempotencyKey
  3. Do not assume ordering across reconnects

​
vs HTTP webhook

​
SDK (coming soon)

The echozero-sdk WebSocket client wraps connect, signal emit, and reconnect. See SDK.