curl --request POST \
--url http://localhost:3000/api/messaging/sessions/{sessionId}/heartbeat
{
"sessionId": "<string>",
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"lastActivity": "2023-11-07T05:31:56Z",
"metadata": {},
"expiresAt": "2023-11-07T05:31:56Z",
"timeoutConfig": {
"timeoutMinutes": 123,
"autoRenew": true,
"maxDurationMinutes": 123,
"warningThresholdMinutes": 123
},
"renewalCount": 123,
"timeRemaining": 123,
"isNearExpiration": true
}
Send a heartbeat to keep a session alive and optionally renew it
curl --request POST \
--url http://localhost:3000/api/messaging/sessions/{sessionId}/heartbeat
{
"sessionId": "<string>",
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"lastActivity": "2023-11-07T05:31:56Z",
"metadata": {},
"expiresAt": "2023-11-07T05:31:56Z",
"timeoutConfig": {
"timeoutMinutes": 123,
"autoRenew": true,
"maxDurationMinutes": 123,
"warningThresholdMinutes": 123
},
"renewalCount": 123,
"timeRemaining": 123,
"isNearExpiration": true
}
ID of the session
Heartbeat received successfully
Complete session information with status and timeout details
Was this page helpful?