Getting started
Quickstart
Pick an app and reach a first result in a few minutes — by hand or with an AI coding agent.
Before you start
Everything is created in the developer console. Three words you will see throughout:
| Term | Meaning |
|---|---|
| Site | One website or app. Sites keep keys, submissions and settings separate. |
| Key | bk_live_… — created per site, shown once, rotatable at any time. |
| Console | Where you add sites, create keys, and read what comes in. |
All apps share one base URL and one authentication header:
Base URL https://api.buckhy.com
Auth X-Api-Key: bk_live_…
Body JSON (Content-Type: application/json)
Form Capture keys are secret and belong on your server. Engage keys (AI Chat, Managed Forms, Support Desk) are publishable and belong in your HTML. Why the difference →
Path A — Form Capture
Store submissions from your existing form through a server endpoint.
- Open Businesses, add or select your website, and verify its domain ownership. Select the intended Test or Live environment.
- Open Apps > Form Capture > Configure. Set the form ID, required fields and notification email. Continue to Integrate and create the server-only credential.
- Store it as a server-side secret:
# .env (never NEXT_PUBLIC_ / VITE_ / client-visible)
BUCKHY_CAPTURE_KEY=bk_live_…
- Post from your server:
// app/api/contact/route.ts
export async function POST(request: Request) {
const fields = await request.json(); // { name, email, message, … }
const upstream = await fetch("https://api.buckhy.com/v1/capture", {
method: "POST",
headers: {
"Content-Type": "application/json",
"X-Api-Key": process.env.BUCKHY_CAPTURE_KEY!,
},
body: JSON.stringify({ form: "contact", page: "/contact", fields }),
});
return Response.json(await upstream.json(), { status: upstream.status });
}
- Submit your form once. Find the record in Businesses > your website > Inbox > Leads and check notification delivery separately.
- Return to the app's Test step, run the checks, then review and Activate. A 201 confirms storage, not email arrival.
Full guide: Install Form Capture.
Path B — Engage SDK
One script tag enables AI Chat and Managed Forms. Support Desk shares the Engage credential but needs your support interface to call its API.
- Open Businesses > your website > Apps. Select AI Chat, Managed Forms or Support Desk, then complete Configure in the intended environment.
- In Integrate, create or reuse the publishable credential and install the generated code. Keep one loader for the shared Engage apps:
<script src="https://api.buckhy.com/v1/engage/sdk.js" defer
data-site-key="bk_live_…"></script>
- Exercise the selected app. Find chats, form leads or support tickets in the website's Inbox.
- Run the app's Test checks and Activate. Inspect notifications and webhook acknowledgements separately from the stored record. Local HTTP origins are supported in Test, not Live.
Full guide: Install the Engage SDK. Then read the app you came for: AI Chat · Managed Forms · Support Desk.
Install with an AI agent
Each install guide opens with a prompt written for coding agents. Paste it into Copilot, Cursor, Claude Code or Windsurf, fill in your key and origins, and the agent does the wiring and verifies it in a browser.
| Path | Prompt |
|---|---|
| Form Capture | Copy the Form Capture prompt |
| Engage SDK | Copy the Engage prompt |
Still read the Verify step afterwards. Agents are good at wiring and less good at noticing a missing origin or a key in the wrong place.
