Visitor SDK Go-Live

Launch checklist

Use this checklist before asking a client to test Ringnity on their public website. It is written for tenant admins and beginner developers.

The examples below use tenant slug your-tenant-slug and public widget key PUBLIC_WIDGET_KEY. Login first to replace placeholders with your real values.

Plan

Subscription and service availability are checked first.

Domain

The website origin must be saved in allowed domains.

Chat

Send one real test message and confirm agent visibility.

Mobile

Open, close, and touch behavior must be comfortable on mobile.

Go-live checklist

Subscription active

Dashboard shows an active subscription. Without this, services can be hidden by plan or billing status.

Allowed domain added

Add the exact client website domain, for example sadavir.id or www.client.com.

Visitor SDK snippet installed

Use the modern Ringnity SDK snippet for new websites. Keep legacy snippets only for existing installs or direct links.

Client website loads the SDK

Open the real website and confirm the launcher or custom buttons are visible.

Chat smoke tested

Open Chat, send a test message, and confirm the agent/dashboard receives it.

Voice tested if included

Open Voice only if the tenant plan and admin settings show voice as available.

AI tested if included

Open AI Chat or AI Voice only after AI readiness is available.

Legacy key handled safely

Public Widget Key may be used in browser snippets. Server API keys must stay on the backend.

Developer docs smoke tested

Confirm /docs/sdk/mobile, /docs/sdk/realtime, platform SDK pages, and Scalar API reference load after deploy.

SDK downloads checked

Confirm the SDK download manifest and source zip artifacts are reachable before sharing SDK links with customers.

Modern Visitor SDK snippet

Use this for new installs. If the page is opened from dashboard, replace the domain and visitor data with the client website values.

<script src="https://api.ringnity.com/sdk/ringnity.js"></script>
<script>
  Ringnity.init({
    slug: 'your-tenant-slug',
    visitor: {
      name: 'Website Visitor'
    },
    onReady: function () {
      console.log('Ringnity is ready');
    },
    onError: function (error) {
      console.warn(error.code, error.message);
    }
  });
</script>

Universal widget and direct link check

Use these checks for simple floating widget installs or direct visitor links. The public widget key is safe for browser usage, but Server API keys must stay on the customer backend.

<script src="https://api.ringnity.com/widget/widget.js?apiKey=PUBLIC_WIDGET_KEY"></script>

https://visitor.ringnity.com/?apiKey=PUBLIC_WIDGET_KEY

Server checks before frontend debugging

Health

Confirms the public SDK API is reachable.

Bootstrap

Confirms the tenant slug, plan, services, and allowed origin work.

Session

Confirms the runtime can create a visitor session.

Website click

Confirms a real visitor can open the support window.

Mobile

Confirms touch, close, and window sizing work on a phone browser.

Docs

Confirms mobile SDK docs, realtime docs, and API reference are live.

Downloads

Confirms SDK source packages and manifest are reachable.

curl "https://api.ringnity.com/api/sdk/health"

curl -H "Origin: https://client-domain.com" \
  "https://api.ringnity.com/api/sdk/bootstrap?slug=your-tenant-slug&debug=true"

Developer docs and SDK downloads smoke

Run these after every SDK docs or package release. They verify the public docs pages, Scalar reference, and downloadable SDK bundles.

curl -fsSL "https://ringnity.com/docs/sdk/mobile" >/dev/null
curl -fsSL "https://ringnity.com/docs/sdk/realtime" >/dev/null
curl -fsSL "https://ringnity.com/docs/sdk/android" >/dev/null
curl -fsSL "https://ringnity.com/docs/sdk/ios" >/dev/null
curl -fsSL "https://ringnity.com/docs/sdk/flutter" >/dev/null
curl -fsSL "https://ringnity.com/docs/sdk/react-native" >/dev/null
curl -fsSL "https://api.ringnity.com/api/docs" >/dev/null
curl -fsSL "https://ringnity.com/downloads/sdk/manifest.json" >/dev/null
curl -fsSL "https://ringnity.com/downloads/sdk/ringnity-web-sdk-0.2.0-draft.zip" >/dev/null
curl -fsSL "https://ringnity.com/downloads/sdk/ringnity-flutter-sdk-0.2.0-draft.zip" >/dev/null
curl -fsSL "https://ringnity.com/downloads/sdk/ringnity-kotlin-sdk-0.2.0-draft.zip" >/dev/null
curl -fsSL "https://ringnity.com/downloads/sdk/ringnity-swift-sdk-0.2.0-draft.zip" >/dev/null
curl -fsSL "https://ringnity.com/downloads/sdk/ringnity-react-native-sdk-0.2.0-draft.zip" >/dev/null

Chat test

Open Chat, send a short message, confirm the conversation appears for an agent, then close the test conversation if needed.

Voice test

Test voice only when the service status is available. If voice infrastructure is offline, document it separately from SDK readiness.

AI test

Test AI only when AI readiness is available. If the status is ai_not_ready, finish knowledge setup first.

When something fails

Start with the troubleshooting page before changing code. Most launch issues are domain, plan, service toggle, or mobile browser behavior.

Open troubleshooting