Guide
API

API

The Api page is where you organise your events into a tree of REST endpoints and try them out. It has two modes, toggled at the top: Builder and API Docs.

Requires an active configuration. Select one on the Settings page first.

The API Builder

Builder mode

  • Left panel — the endpoint tree: groups (folders) containing endpoints. Groups collapse/expand, rows have an inline delete confirm, and a filter box searches the tree.
  • Right panel — the form for the selected item:
    • Group — name (spaces become dashes) and a description.
    • Endpoint — name, parent group, the event it calls, and a description. A URL preview /group/endpoint is shown under the name.
  • Toolbar — New Group / New Endpoint / Save / Test (existing endpoints only) / Delete.

Building an endpoint

  1. New Group — e.g. common.
  2. Select the group, New Endpoint — name it (e.g. users) and pick the event that backs it.
  3. Save. The endpoint is now live at /common/users and exposes whichever HTTP methods the event implements.

The full walkthrough is in the Quick Start.

API Docs mode

A Swagger-style view of the same tree: groups as collapsible cards, endpoints as rows with coloured method badges (only the verbs the event actually handles), the URL path, and the event name. Expanding a row shows the full URL and any curl examples from the endpoint description.

Testing endpoints

Both modes share a Test panel:

  1. A Base URL field, defaulting to https://app.ledgyx.com/rest/v2/{config} (remembered between visits).
  2. Method tabs (active methods only) + the full URL + a Send button.
  3. Headers — key/value pairs, e.g. an API key for authentication.
  4. Query params (GET) or a JSON body (POST/PUT/DELETE), with a Format button.
  5. Response — status badge (coloured by 2xx/4xx/5xx), duration, and the body, with Copy.

Test requests are proxied by the platform, so there are no browser CORS issues. Calling an endpoint from outside still needs an API key — create one on the Settings page.

Related:

EventsSubscriptions