Skip to main content

Quick start for Developers

A minimal integration to fetch and render active notifications fast.

Step 1: Get Your API Key​

As we describe in Quick Start:

  1. Go to Project (click on your project at Projects page)
  2. Click "API Keys"
  3. On this step, you should have 1 API Keys, if not: click "Add API Key"
  4. Copy the key and store it securely
Note

API keys are public, you do not need to hide them.

Step 2: Install KorreroJS​

Using a CDN:​

npm install korrero-js
# or
bun i korrero-js

Using a CDN​

Include the script in your HTML file before the closing </body> tag.

<script src="https://cdn.jsdelivr.net/npm/korrero-js/dist/korrero-js.umd.min.js"></script>

Step 3: Initialize & Auto-Render Notifications​

import { KorreroJS } from 'korrero-js';
// Initialize the SDK with your API key
const korrero = new KorreroJS({
    apiKey: 'your_project_api_key_here',
});

// This single method does all the magic
korrero.renderAuto();

OR, via CDN:

<script src="https://cdn.jsdelivr.net/npm/korrero-js/dist/korrero-js.umd.min.js"></script>
<script>
  // Initialize the SDK with your API key
  const korrero = new KorreroJS({
    apiKey: 'your_project_api_key_here',
  });

  // This single method does all the magic
  korrero.renderAuto();
</script>

Next Step​

Ready to dive deeper? Check out our Project Overview Guide to learn how to organize your notifications effectively.