Record a lifecycle event

Record an install, start, kata completion or finish. Duplicate events are accepted without being counted twice. An installed event can register a public GitHub source when source.repository matches courseId.

POST /api/v1/events

Request Body

application/json

instanceId*string

Random identifier for the local project; do not send names, email addresses or file contents.

courseId*string

event*string

Value in

"installed"
"started"
"kata_completed"
"finished"

occurredAt?string

ISO 8601 timestamp; defaults to the server time.

kata?string

source?

curl -X POST "https://example.com/api/v1/events" \
  -H "Content-Type: application/json" \
  -d '{
    "instanceId": "a-random-project-id",
    "courseId": "dojofoo/effect-ts",
    "event": "installed"
  }'

{
  "accepted": true,
  "duplicate": true
}