Add the Replyful chat widget to your website in minutes.
User identification
Link conversations to your users with secure token-based identification.
API reference
Build on top of Replyful with the REST API.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Replyful","colors":{"primary":"#0098da","light":"#0098da","dark":"#006f9e"},"logo":{"light":"https://mintcdn.com/replyfulab/gbf3ruiAHCeKK7cL/logo/light.svg?fit=max\u0026auto=format\u0026n=gbf3ruiAHCeKK7cL\u0026q=85\u0026s=d99d85a7fa614e8d71ec493389e864c4","dark":"https://mintcdn.com/replyfulab/gbf3ruiAHCeKK7cL/logo/dark.svg?fit=max\u0026auto=format\u0026n=gbf3ruiAHCeKK7cL\u0026q=85\u0026s=bb0e81b6b91fb290787d52337fb73453"},"favicon":"https://mintcdn.com/replyfulab/ELUzAIF8DQXp-7Kr/favicon.svg?fit=max\u0026auto=format\u0026n=ELUzAIF8DQXp-7Kr\u0026q=85\u0026s=70418089ae8eb36c460de7381f90c85a","navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://app.replyful.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"replyfulab","hasAudioNarration":false,"actualSubdomain":"replyfulab","customDomains":["docs.replyful.com"],"gitSource":{"type":"github","owner":"replyful","repo":"replyful","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af31642b9fceafd4089afcf","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API Reference","count":21},{"language":"default","tag":"Guides","count":11},{"language":"default","tag":"Documentation","count":8},{"language":"default","tag":"Getting started","count":5},{"language":"default","tag":"Tickets","count":4},{"language":"default","tag":"Contacts","count":3},{"language":"default","tag":"Channels","count":2},{"language":"default","tag":"Conversations","count":2},{"language":"default","tag":"Knowledge","count":2},{"language":"default","tag":"Chat","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"index","slug":"/","pageMetadata":{"title":"Welcome","description":"Get started with Replyful","href":"/index"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Get started with Replyful\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{Card,Heading}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Welcome to the Replyful documentation. Learn how to add an AI-powered chat widget to your website and integrate with the Replyful API.`}),`\n`,_jsx(Heading,{level:`2`,id:`getting-started`,children:`Getting started`}),`\n`,_jsx(Card,{title:`Install the widget`,icon:`code`,href:`/installation`,horizontal:true,children:_jsx(_components.p,{children:`Add the Replyful chat widget to your website in minutes.`})}),`\n`,_jsx(Card,{title:`User identification`,icon:`user`,href:`/user-identification`,horizontal:true,children:_jsx(_components.p,{children:`Link conversations to your users with secure token-based identification.`})}),`\n`,_jsx(Card,{title:`API reference`,icon:`terminal`,href:`/api-reference/introduction`,horizontal:true,children:_jsx(_components.p,{children:`Build on top of Replyful with the REST API.`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Welcome","description":"Get started with Replyful","href":"/index"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Getting started","slug":"getting-started","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"replyfulab","siteName":"Replyful","title":"Welcome - Replyful","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-30T06:10:10.637Z","originalFileLocation":"index.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Get started with Replyful\">\u003cmeta data-mint-head name=\"application-name\" content=\"Replyful\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/replyfulab/IgVDZiKtCbVMe4J5/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/replyfulab/IgVDZiKtCbVMe4J5/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/replyfulab/IgVDZiKtCbVMe4J5/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/replyfulab/IgVDZiKtCbVMe4J5/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/replyfulab/IgVDZiKtCbVMe4J5/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/replyfulab/IgVDZiKtCbVMe4J5/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/replyfulab/IgVDZiKtCbVMe4J5/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/replyfulab/IgVDZiKtCbVMe4J5/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/replyfulab/IgVDZiKtCbVMe4J5/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Welcome - Replyful\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get started with Replyful\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Replyful\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.replyful.com\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://replyfulab.mintlify.site/_mintlify/api/og/v2?division=Getting+started\u0026amp;title=Welcome\u0026amp;description=Get+started+with+Replyful\u0026amp;theme=827864ad6f88f9e64001cd36\u0026amp;signature=1e3a741c6cc6a4b93948b1462b0cdbd4ba3f56321838db5411b71f7c6b7dd9f6\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Welcome - Replyful\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get started with Replyful\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://replyfulab.mintlify.site/_mintlify/api/og/v2?division=Getting+started\u0026amp;title=Welcome\u0026amp;description=Get+started+with+Replyful\u0026amp;theme=827864ad6f88f9e64001cd36\u0026amp;signature=1e3a741c6cc6a4b93948b1462b0cdbd4ba3f56321838db5411b71f7c6b7dd9f6\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/replyfulab/IgVDZiKtCbVMe4J5/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Replyful\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0098da\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.replyful.com\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/index.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.replyful.com/#organization\",\"name\":\"Replyful\",\"url\":\"https://docs.replyful.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/replyfulab/gbf3ruiAHCeKK7cL/logo/light.svg?fit=max\u0026auto=format\u0026n=gbf3ruiAHCeKK7cL\u0026q=85\u0026s=d99d85a7fa614e8d71ec493389e864c4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.replyful.com#website\",\"name\":\"Replyful\",\"url\":\"https://docs.replyful.com\",\"publisher\":{\"@id\":\"https://docs.replyful.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.replyful.com/#webpage\",\"url\":\"https://docs.replyful.com/\",\"name\":\"Welcome\",\"description\":\"Get started with Replyful\",\"dateModified\":\"2026-04-30T06:10:10.637Z\",\"isPartOf\":{\"@id\":\"https://docs.replyful.com#website\"}},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.replyful.com/#article\",\"headline\":\"Welcome\",\"name\":\"Welcome\",\"description\":\"Get started with Replyful\",\"url\":\"https://docs.replyful.com/\",\"mainEntityOfPage\":{\"@id\":\"https://docs.replyful.com/#webpage\"},\"dateModified\":\"2026-04-30T06:10:10.637Z\",\"publisher\":{\"@id\":\"https://docs.replyful.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.replyful.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Replyful\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Replyful\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/index.md","siteName":"Replyful","nav":{"global":null,"tabs":[{"tab":"Guides","groups":[{"group":"Getting started","pages":[{"title":"Welcome","href":""},{"title":"Install the widget","description":"Add Replyful chat to your website with one snippet, pasted in your HTML or as a Google Tag Manager tag. The same snippet serves the bubble, side panel, full-page and search bar layouts, which you switch in the dashboard.","href":"/installation"},{"title":"Place the chat in your layout","href":"/embed-in-your-app"},{"title":"JavaScript API","href":"/javascript-api"},{"title":"User identification","href":"/user-identification"}]},{"group":"Email","pages":[{"title":"Connect Microsoft 365","href":"/email/microsoft-365"},{"title":"Forward email from Google Workspace","href":"/email/google-workspace-forwarding"}]},{"group":"Chat","pages":[{"title":"Handover to a person","href":"/chat/handover"},{"title":"Data fields","href":"/chat/data-fields"}]},{"group":"Knowledge","pages":[{"title":"Markets \u0026 languages","href":"/knowledge/markets-and-languages"}]},{"group":"Reporting","pages":[{"title":"Customer satisfaction survey","href":"/reporting/customer-satisfaction-survey"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]}]},"basePath":"","title":"Welcome - Replyful","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":[],"chunks":[]}