post__sessions_-id_heartbeat

POST /sessions/{id}/heartbeat

Session Heartbeat

Update session activity and extend the session expiry time. This endpoint is typically called periodically to keep the session alive.

Parameters

Name	In	Type	Required	Description
id	path	string	true	Session identifier

TypeScript Client Library

// Using the Flashback TypeScript client
import { FlashbackClient } from '@flashback/client';

const client = new FlashbackClient({
  accessToken: 'your-access-token'
});

// Send session heartbeat
try {
  const result = await client.sessions.heartbeat('session-id');
  console.log('Session updated:', result);
} catch (error) {
  console.error('Failed to update session:', error);
}

Code Samples

Shell

# You can also use wget
curl -X POST https://backend.flashback.tech/sessions/{id}/heartbeat \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

HTTP

POST https://backend.flashback.tech/sessions/{id}/heartbeat HTTP/1.1
Host: localhost:3000
Accept: application/json

JavaScript

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://backend.flashback.tech/sessions/{id}/heartbeat',
{
  method: 'POST',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://backend.flashback.tech/sessions/{id}/heartbeat',
  params: {
  }, headers: headers

p JSON.parse(result)

Python

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://backend.flashback.tech/sessions/{id}/heartbeat', headers = headers)

print(r.json())

PHP

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://backend.flashback.tech/sessions/{id}/heartbeat', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Java

URL obj = new URL("https://backend.flashback.tech/sessions/{id}/heartbeat");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Go

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://backend.flashback.tech/sessions/{id}/heartbeat", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Example responses

200 Response

{
  "success": true,
  "message": "Session updated successfully",
  "newExpiry": "2019-08-24T14:15:22Z"
}

404 Response

{
  "success": false,
  "error": "Session not found or expired"
}

500 Response

{
  "success": false,
  "error": "Failed to update session"
}

Responses

Status	Meaning	Description	Schema
200	OK	Session updated successfully	Inline
404	Not Found	Session not found or expired	Inline
500	Internal Server Error	Server error	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	Operation success status
» message	string	false	none	Success message
» newExpiry	string(date-time)	false	none	New session expiry time

Status Code 404

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	Operation success status
» error	string	false	none	Error message

Status Code 500

Name	Type	Required	Restrictions	Description
» success	boolean	false	none	Operation success status
» error	string	false	none	Error message

To perform this operation, you must be authenticated by means of one of the following methods: BearerAuth