Docs/SDKs & API/REST API

REST API

Base URL

https://jovial-tern-168.convex.site

Authentication

Include your API key in the Authorization header:

Authorization: Bearer hm_live_xxx

Endpoints

POST /v1/events — Publish Event

curl -X POST https://jovial-tern-168.convex.site/v1/events \
  -H "Authorization: Bearer hm_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "backend",
    "event_type": "task.completed",
    "source": "curl",
    "data": { "description": "Test event" }
  }'

GET /v1/events — Query Events

curl "https://jovial-tern-168.convex.site/v1/events?query=auth&limit=5" \
  -H "Authorization: Bearer hm_live_xxx"

GET /v1/status — Project Status

curl "https://jovial-tern-168.convex.site/v1/status" \
  -H "Authorization: Bearer hm_live_xxx"

POST /v1/locks/:resource — Acquire Lock

curl -X POST "https://jovial-tern-168.convex.site/v1/locks/src%2Fauth.ts" \
  -H "Authorization: Bearer hm_live_xxx"

DELETE /v1/locks/:resource — Release Lock

curl -X DELETE "https://jovial-tern-168.convex.site/v1/locks/src%2Fauth.ts" \
  -H "Authorization: Bearer hm_live_xxx"