← All docs

Developers

SDK and widget

Three ways to put Elioxa chat and data into your product.

Every call has a job. Let it get done.

1. Drop-in widget (no build)

<script src="https://elioxa.com/sdk/widget.js" data-org-slug="elioxa-demo" async></script>
AttributeDefault
data-org-slug—
data-location-id—
data-api-basehttps://api.elioxa.com
window.ElioxaWidget.open();
window.ElioxaWidget.close();
window.ElioxaWidget.startProactive("Need help choosing a plan?");

2. Headless chat — @elioxa/chat-sdk

npm install @elioxa/chat-sdk
import { ElioxaChatSDK } from "@elioxa/chat-sdk";

const chat = new ElioxaChatSDK({ orgSlug: "elioxa-demo" });
await chat.initialize();
await chat.startChat();
await chat.sendMessage("Hello");

Methods: initialize, startChat, sendMessage, getMessages, closeChat, reconnect, getAgentAvailability, startProactiveChat, downloadTranscript, setContextProvider, events message / status / error / ready.

3. REST client — @elioxa/sdk

npm install @elioxa/sdk
import { ElioxaClient } from "@elioxa/sdk";

const client = new ElioxaClient({ apiKey: process.env.ELIOXA_API_KEY });
const queues = await client.listQueues("loc_123");

Calls, wallboard, queues, tickets, work items, hunt groups, meetings, agent scripts, masking, and a raw() escape hatch.

Full references: packages/sdk/README.md · packages/chat-sdk/README.md · developers.md.