Skip to main content
GET
WebSocket events (reference)

Authorizations

api-key
string
header
required

Your raw API key. Generate, rotate, and revoke keys from the merchant dashboard. Keys can optionally be bound to one or more allowed source IPs — requests from any other IP are rejected with API_KEY_IP_DENIED.

Response

(reference only)

Discriminated union of every server-pushed frame on /ws.

event
enum<string>
required
Available options:
connected
data
object
required
ts
integer
required

Unix epoch milliseconds.