Documentation

POST /api/fix/event

Record an event or a piece of feedback against a Fix run.

RequestPOST /api/fix/event
AuthenticationSession cookie optional
Handlerbackend/fixtool.py

What it does

One handler serves `/api/fix/event` and `/api/fix/feedback`. Feedback that asks for no follow-up is acknowledged as such — the response says the follow-up is suppressed rather than silently dropping it.

Authentication

Session cookie optional. The endpoint answers with or without ff_session, but the body is scoped to the session when one is present.

Parameters

ParameterInTypeRequiredDescription
tokenbodystringRequiredThe run the event belongs to.
eventbodystringRequiredThe event name. Refused as `unknown_event` when it is not one the tool defines.
detailbodystringOptionalFree text accompanying the event.

Request

The cookie jar carries the session between calls. Angle-bracketed values are the parameter types from the table above.

curl -s -b cookies.txt -c cookies.txt \
  -X POST -H 'Content-Type: application/json' \
  -d '{"token":"<string>","event":"<string>","detail":"<string>"}' \
  "https://flowfinds.ai/api/fix/event"
const res = await fetch("https://flowfinds.ai/api/fix/event", {
  method: "POST",
  credentials: "include",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    "token": "<string>",
    "event": "<string>",
    "detail": "<string>"
  }),
});
const data = await res.json();
import requests

s = requests.Session()
r = s.post("https://flowfinds.ai/api/fix/event", json={
    "token": "<string>",
    "event": "<string>",
    "detail": "<string>"
  })
data = r.json()

Recorded example

curl -s -b cookies.txt -c cookies.txt \
  -X POST -H 'Content-Type: application/json' \
  -d '{"token":"…","event":"…"}' \
  "$FLOWFINDS_ORIGIN/api/fix/event"

Responses

200Recorded.

FieldTypeDescription
statusstring`recorded`.

200Recorded with follow-up suppressed.

FieldTypeDescription
statusstring`recorded`.
explanationstring'Recorded. Follow-up about this report is suppressed.'

Errors

StatusReasonWhen
400unknown_eventThe event name is not defined.
404No run carries that token.

Related

Back to the API reference index, or read the cookbook for recipes that compose this endpoint with others.