Event stream channel for real-time change data capture. Clients send a POST request with an event source token to open a persistent connection. Fauna pushes events through the open connection as changes occur in the subscribed document or set. The connection remains open until closed by the client or server. If a tracked change occurs, the event source emits a related add, remove, or update event.
Heartbeat or connection status event sent when the stream is opened or periodically to keep the connection alive.
Content-Type: application/json
AddEvent
Event emitted when a new document is added to the tracked set or a document begins matching the tracked criteria.
Content-Type: application/json
RemoveEvent
Event emitted when a document is removed from the tracked set or a document stops matching the tracked criteria.
Content-Type: application/json
UpdateEvent
Event emitted when a tracked document is updated.
Content-Type: application/json
StreamSubscription
Request to open an event stream connection.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.