Skip to main content

Record a client lifecycle event.

POST 

/session/event

Records an event that happened in the client. The event is written to the log and acknowledged; nothing else in the API reads it back, and the response is always the bare { "success": true }.

Two properties are read here, and one event is defined today:

  • event — required, and must be the literal string test.
  • parameters — required object. Its shape is fixed by event; the test event takes a boolean test. Extra keys inside it are ignored.

An event this endpoint does not know is reported against event itself rather than against its parameters, so a wrong event does not also report the parameters it was never going to take.

A client_id is required. It is resolved before the event is validated, so a request that is missing the client and carries a bad event is reported as the missing client first.

Request​

Responses​

The event was accepted and logged.