Skip to main content
POST
/
api
/
agent
/
connect
Connect to an engagement session
curl --request POST \
  --url http://localhost:3000/api/agent/connect \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "institutionId": "<string>",
  "socketId": "<string>"
}
'
{
  "success": true,
  "sessionId": "<string>"
}

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
institutionId
string

Institution ID to connect to

socketId
string

Socket.IO session ID

Response

Connected successfully

success
boolean
sessionId
string

Engagement session ID