baseboard
All integrations

Backend platforms

Custom API

Serve your app's own users, billing, data, files, activity, jobs, uptime or metrics from an endpoint you write, when no built-in provider fits. Baseboard POSTs signed requests to it.

What you see

  • Sign-in, optional

    On the Users page once you fill in Users.
  • Billing, optional

    On the Billing page once you fill in Billing.
  • Databases, optional

    On the Data page once you fill in Data.
  • File storage, optional

    On the Files page once you fill in File storage.
  • Product analytics, optional

    On the Usage page once you fill in Activity.
  • Background jobs, optional

    On the Jobs page once you fill in Background jobs.
  • Uptime, optional

    On the Health page once you fill in Uptime.
  • Metrics, optional

    On the Usage page once you fill in Metrics.

How to connect

  • Paste a key

    A whsec_ secret your endpoint also knows, for example from echo "whsec_$(openssl rand -base64 32)". Every request is signed as Standard Webhooks. Read the guide The key is checked against Custom API before it’s saved, then sealed so only the broker that calls Custom API can open it.
  • From a terminal

    The CLI asks for the same key at a hidden prompt, so an agent running it never sees the key.
    $ npx baseboard-cli connect custom --project k57abc

Settings

Endpoint URLrequired
For example https://app.example.com/api/baseboard
Usersoptional
Your endpoint answers auth.listUsers and auth.listOrganizations.
Billingoptional
Your endpoint answers billing.listCustomers, billing.listSubscriptions and billing.listInvoices.
Dataoptional
Your endpoint answers data.listTables and data.readRows.
File storageoptional
Your endpoint answers storage.listBuckets and storage.listObjects.
Activityoptional
Your endpoint answers analytics.getActivity, and analytics.getActiveUsers for daily active users.
Background jobsoptional
Your endpoint answers jobs.listRuns.
Uptimeoptional
Your endpoint answers uptime.getUptime.
Metricsoptional
Your endpoint answers metrics.list and metrics.read with figures your app counts.
Logo URLoptional
A square image shown for this connection in place of the Custom API icon.For example https://app.example.com/icon.png

Connect Custom API and the rest of your stack in one place.

Free covers one project with three connections. Everyone starts read-only.