Skip to content

Reference

This section answers "What exactly does this do?" — accurate, structured facts about the Conflux system for engineers who are working and need to look something up.

Reference material mirrors the system and stays in sync as things change. It does not explain concepts or guide you through tasks — for that, see Explanation or the How-to Guides.

API Reference

API endpoint documentation is generated automatically from controller docblocks via Scribe. See the API docs for the full, up-to-date reference. To regenerate after a change:

docker compose exec php php artisan scribe:generate
  • API Authentication — authenticatable model, the connection guard, route protection middleware, test setup, and Scribe configuration.
  • API Errors — RFC 9457 Problem Details format, handled exception types, example responses, and the #[ApiProblem] Scribe attribute.
  • Webhook Receiver — inbound webhook endpoint, HMAC-SHA256 signature validation, processing pipeline, and error responses.
  • Tracing — W3C traceparent format, HTTP headers, queue payload keys, log fields, and implementation classes.