Skip to main content
POST
Send a visitor message

Try it in this order

1

1. Bootstrap

Open Bootstrap. Enter your index ID, click Try it, then Send. The playground saves your accessToken for the next two pages. You can only use it on this site, and it expires in about 15 minutes.
2

2. Send a message

Open Send a message. This page fills in your token and index ID. Send Hello. The playground saves your sessionId (wrun_…).
3

3. Stream the reply

Open Stream events. This page fills in your token and that sessionId. Click Send to read the reply.
To send another message, go back to Send a message and click Send again. Then open Stream events once more. The playground updates the session id to that new turn. This is step 2. After you bootstrap, this page fills in your token. After Send, open Stream events to read the reply.

Authorizations

Authorization
string
header
required

accessToken from POST /webless/v1/bootstrap. Get it on the Bootstrap docs page (Send in the playground) or use POST Send a message for the full flow.

Query Parameters

indexId
string
required

Your Webless index ID

Body

application/json
message
string
required

Visitor message. Hello is enough to see a reply.

Example:

"Hello"

Response

Turn accepted. Read the reply from the session stream.

ok
boolean
Example:

true

sessionId
string

Pass this to the stream route.

Example:

"wrun_01EXAMPLE"

status
string
Example:

"accepted"