Getting Started

Getting Started with New Instancelink

New Instance is a multi-product developer platform. This documentation covers the supported REST endpoints and product integration guides.

---

Productslink

Cross-cutting references: Webhooks — Receiving Platform Events, Errors, Rate Limits & Troubleshooting, Go-Live Checklist, End-to-End runnable flow.

---

Create your account and organisationlink

1. Sign up at https://www.newinstance.cloud — this creates your account.
2. Log in to the merchant dashboard at https://app.newinstance.cloud.
3. Create an Organisation (org) — all products are provisioned per org.

---

Base URLs and environmentslink

There is no separate sandbox host. Test safely against the same production URL with a test-mode key (sk_test_…): test and live keys are stored in physically separate collections server-side, so test-key traffic can never read or write live data. Switch to a sk_live_… key when you go to production — see Go-Live Checklist.

The environment variable in this collection is a data label you attach to events (production / staging / development) and the Secret Manager environment selector — it does not change which host you call.

---

Generate a central API keylink

API keys are created at Dashboard → Org → API Keys (/dashboard/org/[orgId]/api-keys).

Key format: sk_test_<keyId>:<secret> (test) or sk_live_<keyId>:<secret> (live)

The full keyId:secret string is shown once — copy it immediately.

Security rule: The keyId:secret form is for server-to-server calls only. Never embed it in browser code, mobile apps, or client-side scripts.

---

Permission scopeslink

When creating a key you choose which product(s) and permission groups it covers. Each product has its own scope codes:

BugWatch scopes

Support Tickets scopes

Secret Manager scopes

Chat scopes (widget key — keyId only, no secret)

Docs Portal scopes

---

The authentication schemeslink

---

Environment variableslink

{
  "success": true,
  "message": "API key is valid",
  "business": { "id": "org_abc123", "name": "Acme Corp", "slug": "acme-corp" },
  "key": { "id": "sk_test_abc123", "environment": "test" },
  "timestamp": "2026-06-26T10:00:00.000Z"
}

{
  "success": true,
  "message": "API key is valid",
  "business": {
    "id": "org_abc123",
    "name": "Acme Corp",
    "slug": "acme-corp"
  },
  "key": {
    "id": "sk_test_abc123",
    "environment": "test"
  },
  "timestamp": "2026-06-26T10:00:00.000Z"
}

curl -X GET 'https://api.newinstance.cloud/api/auth/verify'