API Documentation

Create your account

Sign up for free — no credit card required. Your account starts on the Free plan with 25 AI conversations per month, forever.

Copy your API key

Go to Settings in the dashboard and copy your API key. It starts with nd_live_.

Add the script tag

Paste this snippet before the closing </body> tag on every page where you want guidance. Works with any framework — React, Vue, Angular, vanilla HTML.

<script>
  ActivationKit('init', {
    apiKey: 'YOUR_API_KEY',
    apiUrl: 'https://api.activationkit.com'
  });
</script>
<script src="https://api.activationkit.com/sdk/nd.js" defer></script>

Deploy and watch it work

Deploy your app. On the first page load, the SDK extracts your page structure and sends it to the API for AI enrichment. Within minutes, a help widget appears and the AI can answer questions about your product, highlight elements, and generate on-demand tours.

Check the Schema page in the dashboard to see what the AI discovered — routes, elements, sections, and tours.

Pass user context (optional)

For tier-aware guidance and per-user progress tracking, pass user identity in the init config. This enables the AI to detect gated features and suggest upgrades contextually.

<script>
  ActivationKit('init', {
    apiKey: 'YOUR_API_KEY',
    apiUrl: 'https://api.activationkit.com',
    user: {
      id: 'user_123',
      plan: 'pro'  // 'free', 'pro', or 'business'
    }
  });
</script>
<script src="https://api.activationkit.com/sdk/nd.js" defer></script>

Create a Slack Incoming Webhook

Go to api.slack.com/apps → Create New App → From scratch. Name it anything (e.g. "ActivationKit"). Then enable Incoming Webhooks, click Add New Webhook to Workspace, and select a channel.

Copy the webhook URL — it looks like https://hooks.slack.com/services/T.../B.../xxx

Paste it in Settings

Go to Settings in your ActivationKit dashboard. Scroll to Pulse — Real-Time Alerts, paste the webhook URL, and click Connect.

A test message is sent automatically to verify the connection.

Done — you'll receive these notifications