Documentation
This is how XICBOT works: from setup and the widget on your website to the API. Every page describes what the application actually does and states its limits.
In plain language
This is the XICBOT documentation. It explains how XICBOT works. It covers setup, knowledge and the widget on your website. It also covers chats, the team and the API. Every page says what the application does. It also states its limits. The pages are sorted by topic.
- topics
- 45
- sections
- 8
Searches titles, descriptions and section headings.
Getting started
From the account to the first conversation on your website.
- Quick start Four steps to a working assistant: create the account, set up assistant and knowledge, check in the test dialog, embed the chat window, plus the overview.
- Sign-in, sign-up and access Create an account, confirm your address, sign in with a password, code or security key, reset your password and accept a team invitation.
- How the application is laid out Header bar, area column, command line, status bar and overview: how the application is laid out, which language it shows and what you can set on your device.
Assistant and knowledge
Create assistants, build knowledge and check answers before going live.
- Setup from your website Your website address is turned into a proposal for your assistant. You review each line, edit or drop it, and then create the assistant.
- Create and maintain assistants Creating assistants, basics, building blocks, master data, handover, versions and deletion: what each field does, which limits apply and who may change it.
- Maintain knowledge Add sources, refresh websites, restore versions, maintain question-answer pairs and the probe set: each Knowledge field with its limits and messages.
- How knowledge and answers are built What happens between a source and a cited answer: reading, splitting into chunks, search, coverage, citations and the check of hard details in the reply.
- Test dialog and acceptance Check answers in the test dialog before embedding, and record an acceptance with check questions: fields, limits, verdicts, messages and API.
Website widget
Embedding, settings, appearance and consent of the chat widget.
- Embed the widget Copy the embed code from the app and add it to your website, via cdn.xicbot.de or your own path on your domain, with enablement, a domain list and a load check.
- Widget settings Every chat window setting in the app: fields with limits and defaults, roles, saving, preview, embedding status and generating a new key.
- Script attributes of the embed code All eight attributes of the chat window's embed code: key, path, interface, colour, corner, language and consent, with accepted values, defaults and precedence.
- JavaScript interface and browser storage window.xicbot with einwilligen, widerrufen and stand, the messages between your page and the chat window, and each browser storage entry with its expiry.
- Appearance, languages and accessibility Look, position and operation of the chat window on your website: fields, trigger, image, colours, languages, keyboard and accessibility.
- Outreach rules Greet visitors with one sentence after a set time, a share read, a pause, on leaving or on a return visit: rules, limits, path filter and speech bubble.
- Form prefill Set up the Prefill form tool: field mapping, confirmation in the chat, what gets entered on your page and which report you receive afterwards.
- The conversation in the widget How the chat window starts, resumes conversations, streams answers and shows citations, tool cards, product cards, ratings and attachments, with every message.
- Consent and visitor rights How to require consent before the first conversation, and how visitors get information, withdraw consent and delete their conversation in the chat window.
- Widget delivery and security How XICBOT delivers the loader and the chat window: versioned file names, checksums, security policy, response headers, key checks and per-visitor limits.
Tools and actions
What the assistant can do besides answering: catalogue, appointments, requests and custom tools.
- Create and approve tools Create tools under Triggers › Tools: tool types, key, required fields, minimum role, approval and how to connect your own interfaces.
- Catalogue, basket and shop connection Maintain and import the product catalogue, connect and sync a shop, product search, product cards and basket handover: fields, limits, messages.
- Appointments and cases Set up appointment types, time windows and buffers, and work through enquiries, appointments and baskets under Cases, with every field, status and message.
- Tool kit for custom connections Client, signature check and stream reader in Node, PHP and Python: call the API, verify webhooks and answer calls from XICBOT to your system.
Conversations and team
Review conversations, the inbox, team roles and analytics.
- Conversations Find, filter, take over and hand over conversations, request logged plain text, block visitors, set retention periods and use the matching API.
- Inbox and routing Work through open handovers to a human: the list, assignment, availability, marking as done and the rules that route each handover to a queue.
- Team, roles and audit log Invite people, assign and change roles, remove members, keep an eye on seats and check in the audit log who did what in the account.
- Analytics: metrics, gaps and the weekly report Which metrics analytics counts, how period and assistant filter them, what “not measured” means and how the weekly report reaches the account owner by email.
Account, plans, privacy
Account and sign-in, plans and quotas, data protection, retention and deletion.
- Account and sign-in security Change your password, set up two-factor authentication with a code or security key, end signed-in devices and review recent sign-ins.
- Plans, quotas and billing The Start, Pro and Custom plans with limits and features, the monthly quota with warning threshold and throttling, and every field under Billing.
- Privacy and legal in your account Legal texts, the data processing agreement, sub-processors, stored data, the data export and account deletion on the Legal and data page.
- Retention and deletion Set retention periods per type of data, see what the daily and hourly clean-up runs remove, delete single conversations and delete the whole account.
Operations and security
How data is protected, what runs in the background, backups and updates.
- Data security and tenant isolation How XICBOT keeps accounts apart, checks roles, masks personal data, logs plain-text access and limits outgoing requests to public targets.
- Background jobs Which work XICBOT does in the background, in what order, how often a failed job is retried and how long jobs are kept.
- Scheduled tasks Which recurring runs XICBOT starts and at what time, what each run takes care of, and how a failed or missing run gets noticed.
- Availability, status and alerts Public status and changelog endpoints without sign-in, headers and error responses, the operator's operations area, and how to spot a takeover of your account.
- Backups and updates What the daily backup contains, how long backup sets are kept, how a restore works and what happens to your data while XICBOT is updated.
API reference
Authentication, limits and every API endpoint with request and response fields.
- API basics Base address and version of the XICBOT API, access zones, error formats, response headers, HTTPS, CORS, pagination and safely repeating requests.
- API authentication: sessions, keys and permissions Session tokens, API keys and the chat window key: how to authenticate against the API, which scopes, roles and caps apply, and which errors you get back.
- API limits: plan gates and throttles Which API endpoints depend on plan features and count limits, which named throttles apply with which values, and what the 402, 429 and 503 responses look like.
- Public API endpoints Sign-up, sign-in, password reset, status, enquiries, demos, invitations and cart pickup: every API endpoint you can call without a session.
- Widget endpoints All 14 widget endpoints under /api/v1/public/widget/{key}: settings, conversation, answer stream, consent, data export, deletion, tool calls and attachments.
- Integration endpoints Using an API key: read conversations, enquiries, appointments and metrics, create enquiries and sources, stream chat replies as server-sent events.
- API keys and webhooks Create API keys with scopes, limits and expiry, set up webhooks for ten events, verify signatures and track deliveries.
- API: account, security, billing and privacy Endpoints for profile, account switching, password, two-factor authentication, security keys, sessions, billing, data export, retention and account deletion.
- Knowledge and assistant endpoints App API endpoints for knowledge sources, search, probe sets, setup, assistants, acceptance checks and tools, with fields, roles and errors.
- Conversation and management endpoints App session endpoints for conversations, visitor blocks, team, routing, catalogue, shop, analytics, cases and audit log: fields, limits, roles and errors.
Your topic is not listed yet?
Tell us what you were looking for. We reply personally.