Skip to content

Replay API

Replay is available on Plus and requires standard authenticated user access to the HookNexus web app session.

Endpoints

`GET /api/replay/targets/:requestId`

Returns online replay targets for the endpoint that owns the stored request.

Use this before dispatch so the user can choose a connected client.

`GET /api/replay/preview/:requestId`

Returns the stored request snapshot:

method
path
headers
query
body
content type

`POST /api/replay`

Dispatches a saved request to a selected online non-web client.

Request body

{
  "requestId": "req_123",
  "connectionId": "conn_123"
}

Successful response

{
  "success": true,
  "statusCode": 202,
  "statusText": "Dispatched",
  "connectionId": "conn_123",
  "clientType": "cli",
  "clientMode": "forward",
  "dispatchedAt": "2026-03-28T10:00:00.000Z"
}

Common failure cases

Status	Meaning
`401`	Not authenticated
`403`	Replay requires Plus
`404`	Request not found
`409`	No replay targets online, or selected target went offline