Build a revenexx App

A hands-on path to building, deploying, and verifying a revenexx App — from an empty directory to a live capability behind the API gateway.

These tutorials take you from an empty directory to a working revenexx App that serves a real API capability through the gateway. You build the app, run it against an in-memory data store on your laptop, deploy it with the revenexx CLI, and confirm it answers a real request at https://api.revenexx.com.

An App is the unit of installable business logic on Revenue Cloud. It owns its own data tables, exposes HTTP capabilities through the API gateway, and gets multi-tenancy, deployment, and API generation handled for you. You declare what the app is in a few JSON files and write the custom logic as a small Node function. For the bigger picture of what an App is and how it's published, read the App Marketplace overview.

What you'll build

A small Locations app: one entity (a stock location), full CRUD over the gateway, a custom batch endpoint, and a seeded default. By the end you'll have deployed it and called it live. The later tutorials add a second entity, relationships, a custom action route, and the deploy-and-verify loop in full.

Prerequisites

  • The basics from Prerequisites — a revenexx account and a tenant slug.
  • Node.js 22 or newer.
  • The revenexx CLI installed and signed in (revenexx login).
  • A machine-to-machine API key for your tenant, created in Cockpit. You send it as X-Revenexx-Api-Key when you call the gateway.

You write apps against the App SDK (@revenexx/app-sdk), which gives you a typed data client over your app's tables and a small HTTP router for the function.

The path

In a hurry? revenexx create app <name> scaffolds the whole app in one command — see Scaffolding. These tutorials build the same thing by hand so each file makes sense.

  1. Build your first app — scaffold the files, declare one entity, mount CRUD, generate the capability list, test locally, deploy, and verify.
  2. Add a data model — a second entity, a relationship, a custom action route with guards, and the typed data client in depth.
  3. Deploy with the CLI — the full deploy-and-verify loop with the revenexx CLI, plus a caching note for read-heavy capabilities.

Where to go next

  • App SDK — the data client and router you build the app with.
  • CLI — the command-line tool you deploy with.
  • App Marketplace — what an App is and how publishing works.
Was this page helpful?