@replayio-app-building/netlify-recorder 0.15.4 → 0.15.5

package/README.md

@@ -112,7 +112,7 @@ export default createRecordingRequestHandler(
 
 ### 2. Create recordings
 
-When you want to turn a captured request into a Replay recording, POST to the service's `create-recording` endpoint with the request ID:
+When you want to turn a captured request into a Replay recording, POST to the service's `create-recording` endpoint with the request ID. If the request was created with a secret, you must include it:
 
 ```typescript
 const response = await fetch(
@@ -122,6 +122,7 @@ const response = await fetch(
     headers: { "Content-Type": "application/json" },
     body: JSON.stringify({
       requestId,
+      secret,
       webhookUrl: "https://your-app.netlify.app/api/on-recording-complete", // optional
     }),
   }
@@ -144,17 +145,19 @@ On failure:
 
 ### 3. Check recording status
 
-You can poll the recording status at any time:
+You can poll the recording status at any time. If the request was created with a secret, you must include it:
 
 ```typescript
 const res = await fetch(
-  `${RECORDER_URL}/api/get-request?requestId=${requestId}`
+  `${RECORDER_URL}/api/get-request?requestId=${requestId}&secret=${secret}`
 );
 const { status, recordingId } = await res.json();
 // status: "captured" | "processing" | "recorded" | "failed"
 // recordingId: string | null
 ```
 
+Requests created with a secret return 403 if the secret is missing or incorrect.
+
 ### 4. Access control with secrets
 
 You can restrict access to captured requests by setting a `secret` string. When a secret is set, the request is only accessible via API calls that provide the same secret value. This lets each app isolate its requests from other apps sharing the same Netlify Recorder service.
@@ -179,11 +182,11 @@ export default createRecordingRequestHandler(
 
 #### Listing requests by secret
 
-Use the `list-by-secret` endpoint to retrieve all requests associated with a secret, with optional filtering by status, handler path, and time range:
+Use the `requests` endpoint with a `secret` parameter to retrieve all requests associated with your secret, with optional filtering by status, handler path, and time range:
 
 ```typescript
 const res = await fetch(
-  `${RECORDER_URL}/api/list-by-secret?secret=${secret}&status=recorded&handlerPath=netlify/functions/my-handler&after=2025-01-01T00:00:00Z&before=2025-12-31T23:59:59Z`
+  `${RECORDER_URL}/api/requests?secret=${secret}&status=recorded&handlerPath=netlify/functions/my-handler&after=2025-01-01T00:00:00Z&before=2025-12-31T23:59:59Z`
 );
 const { rows, total, page, limit } = await res.json();
 ```
@@ -193,13 +196,16 @@ Query parameters:
 | Parameter | Description |
 |---|---|
 | `secret` | **(required)** The secret string used when creating the requests |
-| `status` | Filter by status: `captured`, `queued`, `processing`, `recorded`, `failed` |
+| `id` | Search by request ID prefix |
+| `status` | Filter by status: `captured`, `queued`, `processing`, `recorded`, `failed`, `all` |
 | `handlerPath` | Filter by handler path (exact match) |
 | `after` | Only include requests created at or after this ISO timestamp |
 | `before` | Only include requests created at or before this ISO timestamp |
 | `page` | Page number (default 1) |
 | `limit` | Page size (default 20, max 100) |
 
+Without a `secret` parameter, only requests created without a secret are returned.
+
 #### Checking request status with a secret
 
 When a request was created with a secret, you must include the secret when polling its status:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@replayio-app-building/netlify-recorder",
-  "version": "0.15.4",
+  "version": "0.15.5",
   "description": "Capture and replay Netlify function executions as Replay recordings",
   "type": "module",
   "exports": {