Hoppa till dokumentationen

AI-kodassistenter

Kixo är byggt för AI-first-team, så dokumentationen innehåller instruktioner att kopiera och klistra in för kodassistenter. Använd den här sidan när Codex, Claude Code, Cursor, Copilot, Windsurf eller en annan LLM integrerar SDK i din produkt.

Obs!

De här filerna är offentliga och stabila: /llms.txt, /llms-full.txt och /ai/kixo-agent-brief.md.

Ge den här briefen till agenten

text
Kixo is a B2B analytics, campaigns, and AI-chat platform. Integrate Kixo into the customer's app; end users do not log in to Kixo.

Use exactly one SDK for the target platform:
- Web: https://cdn.kixo.io/kixo.min.js (script embed; npm @kixo.io/web)
- iOS: Swift Package https://github.com/kixoio/kixo-ios-sdk, import Kixo
- Android: Maven repo https://raw.githubusercontent.com/kixoio/kixo-android-sdk/main/repo, dependency io.kixo:kixo-android-sdk:0.1.20, import io.kixo.sdk.Kixo

Configure once at app startup:
- Web app entry or head: Kixo.init({ projectId, apiKey })
- iOS App init or AppDelegate: Kixo.configure(projectId:apiKey:)
- Android Application.onCreate: Kixo.configure(context = this, projectId, apiKey)

Use dashboard Project ID and SDK API key placeholders. Never commit real keys. Never use dashboard or admin tokens in client apps.

Do not duplicate Kixo's auto-tracked page, screen, session, click, tap, error, crash, or push lifecycle events. Add custom events only for product-specific actions.

Event naming: one event per user action, context in properties. Use snake_case, object_verb, past tense, same names across Web, iOS, and Android. Include stable entity IDs such as post_id, order_id, video_id.

Prefer canonical standard events or typed helpers where available: signup, activation, purchase, subscribe_start, subscribe_renewed, trial_start, cancel, upgrade, downgrade, share, invite.

Identity: call identify only when a stable product user ID is known. Put email, name, and plan in traits such as $email, $name, $plan. Call reset on logout.

Use boolean user properties for durable segmentation tags, e.g. Kixo.setUserProperty("subscribe", true) or vip: true.

Replay is enabled from Kixo project settings. Mouse-move heatmaps are disabled by default. The SDK collects the trackers enabled by the customer and the events and properties their application sends. Use only APIs listed in the current platform SDK reference; do not invent policy controls.

Project collection settings can override local SDK defaults. Do not expose or document internal Kixo dev-routing flags.

Deep Links: use the exact branded host from Kixo Project Settings. Never use a wildcard or the base Kixo domain. Android needs the exact-host App Links manifest filter, release package name, every SHA-256 signing fingerprint, and warm onNewIntent forwarding to Kixo.handleDeepLink. iOS needs the exact applinks: entitlement and cold/warm lifecycle forwarding. Keep navigation inside the app and test both cold and warm opens. Full guide: https://docs.kixo.io/deep-links.

Verify by triggering one auto event and one custom event, checking diagnostics() where available, and confirming events in the Kixo dashboard or chat.

Var filerna ska ligga

AssistentRekommenderad fil i appens repo
CodexAGENTS.md och vid behov .agents/skills/kixo-sdk-integration/SKILL.md
Claude CodeCLAUDE.md, helst med import av den gemensamma AGENTS.md
Cursor.cursor/rules/kixo.mdc
GitHub Copilot.github/copilot-instructions.md och valfria promptfiler
Agenter i stil med Windsurf eller Cascade.devin/rules/kixo.md eller verktygets katalog för projektregler

Nedladdningsbara mallar

Checklista

  • SDK konfigureras bara en gång när appen startar.
  • Inga dashboard-token, administratörsuppgifter eller riktiga hemligheter checkades in.
  • En automatiskt spårad händelse visas i Kixo.
  • En produktspecifik anpassad händelse visas i Kixo.
  • Identitet sätts först när ett stabilt användar-ID i produkten är känt.
  • Utloggning anropar reset.
  • Händelsenamn följer spårningsmönster.
  • Deep Links använder exakt värdnamn och skickar med checklista för kall och varm start.