API docsSuccess tooling

Calculate adoption readiness across every customer lifecycle

Compare language SDKs, inspect sample responses, and understand the prerequisites for scoring adoption momentum.

Open API explorer
POST

POST https://api.nextbase.com/v1/adoption/readiness

Auth: Workspace token (server-side)

Open API explorer

Rate limit

120 requests / minute

Soft limit; contact support for burst credits.

Idempotency

Optional

Use the Idempotency-Key header for asynchronous retries.

Beta flag

adoption-readiness

Enable inside the Nextbase console

Docs maintainer

Developer platform guild

Authenticate and request

Authenticate with your workspace token, then call the adoption readiness endpoint with target account metadata.

All requests must originate from server environments. Tokens scoped to "adoption.read" and "scoring.calculate" provide least privilege.

  1. Configure workspace token permissions inside the console.
  2. Set the `X-Nextbase-Region` header for data residency.
  3. Send account identifiers and optional success signals payload.

Language-specific example

Subscribe to webhook updates

Receive webhook notifications when adoption readiness crosses thresholds so your workflows can react in real time.

Register a webhook endpoint and confirm the challenge handshake. Subscriptions can filter by readiness band (e.g., "at-risk", "expansion").

Tip

Store the webhook signature header and validate using the workspace secret to avoid replay attacks.

Language-specific example

PreviousSegmenting readiness bandsNextAutomate success plays
Language rail
Sticky code samples synced with the active section.
Node.js
Using the official sdk
import { Nextbase } from "nextbase";

const client = new Nextbase({ token: process.env.NEXTBASE_TOKEN });

const readiness = await client.adoption.readiness.calculate({
  accountId: "acct_91fd92",
  signals: {
    lastSeenAt: "2025-08-01T15:20:12.000Z",
    seatsActivated: 42,
    successPlanStage: "expansion",
  },
});

console.log(readiness.score);
Runtime tips
Guard against production surprises before pushing new integrations.

Environment isolation

Pin requests to staged services before toggling production flags.

Regional rollouts

Check latency budgets when enabling edge cache purges.