Docs

Everything needed to run Kivunly, including the contract for pointing it at your own backend instead of ours.

Requirements

Install

  1. In WordPress: Plugins → Add New Plugin, search for Kivunly, then Install Now and Activate. The listing is at wordpress.org/plugins/kivunly.
  2. Go to Settings → Kivunly.
  3. Paste your chat endpoint and site key, tick Enable widget, and save.

Nothing is loaded on your pages until the widget is enabled and an endpoint is set. Before that, the plugin adds no CSS, no JavaScript and no network requests.

Settings reference

SettingWhat it does
Enable widgetMaster switch. Off means nothing loads at all.
Chat endpointThe HTTPS URL that receives visitor messages and returns replies.
Site keyIdentifies your site to the backend. With the hosted service a key only works on the domain it was issued for.
Bot nameShown in the chat header. Defaults to your site title.
TaglineThe small line under the bot name.
Greeting messageThe first message a visitor sees. Ask a question here rather than saying hello.
Teaser bubbleThe small prompt near the closed chat button. Leave empty to disable.
Suggested questionsOne per line. Shown as tappable buttons when the chat opens.
PositionBottom-right or bottom-left. Left usually reads better on right-to-left sites.
Accent colour / header colourHex values used for the button, the visitor's messages and the header.
Logo URLOptional image shown in the chat header.

The backend contract

Kivunly's plugin is a front end. It sends one POST request per visitor message and renders what comes back, which means you can point it at any endpoint that speaks this format.

Request

The widget POSTs JSON to your endpoint:

{
  "message": "where do I start with sustainable shopping?",
  "history": [
    { "role": "user", "content": "hi" },
    { "role": "assistant", "content": "Hi! What are you looking for?" }
  ],
  "key": "your-site-key",
  "page": "https://example.com/blog/current-page/"
}

Response

{
  "reply": "A good place to start is [Ethical Superstore Review](https://example.com/ethical-superstore-review/).",
  "suggestions": ["Show me eco-friendly shops", "Best sustainable fashion?"]
}

Building your own

Any HTTPS endpoint works: a serverless function, a small server, or an automation tool such as n8n or Make. A workable backend needs four steps — validate the key, fetch the relevant pages from the site (WordPress exposes /wp-json/wp/v2/posts publicly), ask a model to answer using only those pages, and return the JSON above. Ground it properly: see why AI chat widgets invent links.

Your endpoint must allow cross-origin requests from your site's domain, since the widget calls it from the visitor's browser.

What data leaves the site

Only what is needed to produce a reply, and only to the endpoint you configured:

The plugin sets no cookies, loads no third-party scripts and sends no analytics. Conversation history lives in the browser tab's sessionStorage and disappears when the tab session ends. If you use the hosted service, its terms and privacy policy apply.

Hosted service limits (beta)

LimitCurrent value
Messages per visitor8 per minute
Messages per site300 per day
Conversation memoryLast 8 messages
Content refreshAutomatic, on a schedule
Key scopeOne key per site; a key used on another domain is refused

These are beta values intended to keep costs predictable, and they will change as the service grows. Running your own backend means your own limits.

Troubleshooting

SymptomCheck
No chat bubbleWidget enabled? Endpoint set? Page cache cleared?
"Sorry, something went wrong"The endpoint is unreachable or returned invalid JSON. Open the endpoint URL directly to confirm it is alive.
Answers ignore your contentThe backend is not grounded in your site's pages.
Chat refuses with a key messageThe key is wrong, or it is being used on a domain it was not issued for.
New posts are missingWait for the next content refresh; confirm the posts are public and appear in your site's REST API.

Related

HomeWordPress.org pluginFAQPrivacy