Send an event

Send one event to the chat and receive a streaming JSON array of events in response.

Only one send-event request should be in flight per chat at a time — disable user input until the stream completes. The backend will hold the connection open for up to 60 seconds; clients should match this with an AbortController to avoid stalled connections locking the UI.

The response stream includes the same user event that the client sent. If the UI already rendered that message optimistically, ignore the streamed copy with the same id to avoid showing the shopper's message twice.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
string
required
Body Params
event
required
string
required
string | null
string | null
string | null
boolean | null
agentPayload
object | null
Responses

400

Bad Request — invalid event format or missing required field.

404

Not Found — unknown projectId, personaId, or chatId.

429

Too Many Requests — rate limit exceeded. Back off before retrying.

500

Internal Server Error — backend error.

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

© Bloomreach, Inc. All rights reserved.