message.created. Use webhooks
for other event types.
- Realtime quickstart — open a connection, handle frames, ack, and resume, with a runnable listener.
- Realtime endpoint reference — the generated request and response schema.
Realtime guide
Use realtime when an online integration needs live ProductEvent delivery.
Realtime delivers events live over a WebSocket, so a client that is online now
can react without polling. It is not a durable event log — use webhooks instead
when you need HTTP delivery you can log, retry, and replay.
Realtime does not use a separate long-lived key. Your server uses a member,
agent, or service API key to open a temporary WebSocket ticket, then the
WebSocket client connects with the returned ticket URL. See Which key do I use?
for the credential model.
Today realtime delivers one event,