The Form widget is available through our CDN as a single JavaScript file or through NPM as a React component package.
HTML
React
<script type="module">import Form from 'https://cdn.jsdelivr.net/npm/@zappway/embeds@latest/dist/form/index.js';Form.initStandard({formId: 'YOUR_FORM_ID',});</script>
Documentation under construction
Attributes / Props
HTML
React
<script type="module">import Form from 'https://cdn.jsdelivr.net/npm/@zappway/embeds@latest/dist/form/index.js';Form.initStandard({formId: 'YOUR_AGENT_ID',onEnd: function (values) {console.log('Form submitted with values:', values);},})</script>
Documentation under construction
string
required
ID of the AI Employee
function
Callback function that is called when the form is submitted. The function receives the form values as an object.
const form = await Form.initBubble({ agentId: 'YOUR_AGENT_ID', onEnd: function (values) { console.log('Form submitted with values:', values); },})
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ZappWay - Connect custom data to large language models","colors":{"primary":"#009a7e","light":"#009a7e","dark":"#009a7e"},"logo":{"light":"https://mintcdn.com/zappway/NtpMWDbmNmYF-G-B/logo/light.png?fit=max\u0026auto=format\u0026n=NtpMWDbmNmYF-G-B\u0026q=85\u0026s=f65c869bd80f023f03cdca82742ccd6c","dark":"https://mintcdn.com/zappway/NtpMWDbmNmYF-G-B/logo/dark.png?fit=max\u0026auto=format\u0026n=NtpMWDbmNmYF-G-B\u0026q=85\u0026s=ae530bbb482c78f068178a7023554777"},"favicon":"https://mintcdn.com/zappway/4oVALI6FFs2CTuHD/favicon.png?fit=max\u0026auto=format\u0026n=4oVALI6FFs2CTuHD\u0026q=85\u0026s=e2d0cbc8e7370fed9f7600e949d20cec","navbar":{"links":[{"href":"mailto:support@zappway.ai","label":"Support"}],"primary":{"type":"button","label":"⚡️Start for Free","href":"https://zappway.ai/"}},"footer":{"socials":{"x":"https://x.com/zappway","github":"https://github.com/ZappWay/ZappWay"}},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","href":"en/introduction"},{"language":"pt-BR","href":"pt-BR/introduction"},{"language":"es","href":"es/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zappway","hasAudioNarration":false,"actualSubdomain":"zappway","customDomains":["docs.zappway.ai"],"gitSource":{"type":"github","owner":"zappway","repo":"zappway","deployBranch":"main","contentDirectory":"apps/zappway/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aadd7176ea1994f212dca0f","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"en","tag":"AI Employee","count":40},{"language":"es","tag":"AI Employee","count":40},{"language":"pt-BR","tag":"AI Employee","count":40},{"language":"en","tag":"API Reference","count":34},{"language":"es","tag":"API Reference","count":34},{"language":"pt-BR","tag":"API Reference","count":34},{"language":"en","tag":"Integrations","count":24},{"language":"es","tag":"Integrations","count":24},{"language":"pt-BR","tag":"Integrations","count":24},{"language":"en","tag":"Train With","count":20},{"language":"es","tag":"Train With","count":20},{"language":"pt-BR","tag":"Train With","count":20},{"language":"en","tag":"Widgets","count":16},{"language":"es","tag":"Widgets","count":16},{"language":"pt-BR","tag":"Widgets","count":16},{"language":"en","tag":"Datastore","count":14},{"language":"es","tag":"Datastore","count":14},{"language":"pt-BR","tag":"Datastore","count":14},{"language":"en","tag":"Overview","count":11},{"language":"en","tag":"🚀 Install On","count":11},{"language":"es","tag":"Overview","count":11},{"language":"es","tag":"🚀 Install On","count":11},{"language":"pt-BR","tag":"Overview","count":11},{"language":"pt-BR","tag":"🚀 Install On","count":11},{"language":"en","tag":"AI Features","count":8},{"language":"en","tag":"Email Inbox","count":8},{"language":"es","tag":"AI Features","count":8},{"language":"es","tag":"Email Inbox","count":8},{"language":"pt-BR","tag":"AI Features","count":8},{"language":"pt-BR","tag":"Email Inbox","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"en/widgets/form/reference","slug":"/en/widgets/form/reference","pageMetadata":{"description":"Reference","title":null,"href":"/en/widgets/form/reference"},"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: \"Reference\"\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={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading,ParamField,Tab,Tabs,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!Tab)_missingMdxReference(`Tab`,true);if(!Tabs)_missingMdxReference(`Tabs`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The Form widget is available through our CDN as a single JavaScript file or through NPM as a React component package.`}),`\n`,_jsxs(Tabs,{children:[_jsx(Tab,{title:`HTML`,id:`html`,children:_jsx(CodeBlock,{filename:``,numberOfLines:`9`,language:`html`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`html`,children:_jsxs(_components.code,{language:`html`,numberOfLines:`9`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`\u003c`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`script`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#9CDCFE`},children:` type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"module\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`>`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` Form`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` from`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'https://cdn.jsdelivr.net/npm/@zappway/embeds@latest/dist/form/index.js'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`Form`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`initStandard`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`formId:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'YOUR_FORM_ID'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`\u003c/`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`script`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`>`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`]})})})}),_jsx(Tab,{title:`React`,id:`react`,children:_jsx(Warning,{children:`Documentation under construction`})})]}),`\n`,_jsx(Heading,{level:`2`,id:`attributes-/-props`,children:`Attributes / Props`}),`\n`,_jsxs(Tabs,{children:[_jsx(Tab,{title:`HTML`,id:`html-2`,children:_jsx(CodeBlock,{filename:``,numberOfLines:`13`,language:`html`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`html`,children:_jsxs(_components.code,{language:`html`,numberOfLines:`13`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`\u003c`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`script`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#9CDCFE`},children:` type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"module\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`>`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` Form`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` from`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'https://cdn.jsdelivr.net/npm/@zappway/embeds@latest/dist/form/index.js'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`Form`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`initStandard`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`formId:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'YOUR_AGENT_ID'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`onEnd`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` function`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` (`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`values`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`console`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`log`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Form submitted with values:'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`values`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`})`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`\u003c/`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`script`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`>`})]}),`\n`]})})})}),_jsx(Tab,{title:`React`,id:`react-2`,children:_jsx(Warning,{children:`Documentation under construction`})})]}),`\n`,_jsx(ParamField,{path:`formId`,type:`string`,required:true,id:`param-form-id`,children:_jsx(_components.p,{children:`ID of the AI Employee`})}),`\n`,_jsxs(ParamField,{path:`onEnd`,type:`function`,id:`param-on-end`,children:[_jsx(_components.p,{children:`Callback function that is called when the form is submitted. The function receives the form values as an object.`}),_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` form`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` Form`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`initBubble`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` agentId:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'YOUR_AGENT_ID'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` onEnd`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` function`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` (`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`values`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` console`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`log`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Form submitted with values:'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`values`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`})`})}),`\n`]})})})]}),`\n`,_jsx(CodeBlock,{numberOfLines:`1`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsx(_components.code,{language:`text`,numberOfLines:`1`,children:_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})})})})]})}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":{"description":"Reference","title":null,"href":"/en/widgets/form/reference"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Attributes / Props","slug":"attributes-/-props","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"zappway","siteName":"ZappWay - Connect custom data to large language models","title":"Reference - ZappWay - Connect custom data to large language models","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/en/widgets/form/reference","matchLevel":0},"pt-BR":{"href":"/pt-BR/widgets/form/reference","matchLevel":1},"es":{"href":"/es/widgets/form/reference","matchLevel":1}}},"lastModified":"2026-09-09T04:59:59.194Z","originalFileLocation":"en/widgets/form/reference.mdx","locale":"en"},"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=\"Reference\">\u003cmeta data-mint-head name=\"application-name\" content=\"ZappWay - Connect custom data to large language models\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zappway/nA6plCD2-OvUMbgI/_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/zappway/nA6plCD2-OvUMbgI/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zappway/nA6plCD2-OvUMbgI/_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/zappway/nA6plCD2-OvUMbgI/_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/zappway/nA6plCD2-OvUMbgI/_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/zappway/nA6plCD2-OvUMbgI/_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/zappway/nA6plCD2-OvUMbgI/_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/zappway/nA6plCD2-OvUMbgI/_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/zappway/nA6plCD2-OvUMbgI/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Reference - ZappWay - Connect custom data to large language models\">\u003cmeta data-mint-head property=\"og:description\" content=\"Reference\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ZappWay - Connect custom data to large language models\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.zappway.ai/en/widgets/form/reference\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zappway.mintlify.site/_mintlify/api/og/v2?division=Form\u0026amp;title=Reference\u0026amp;description=Reference\u0026amp;theme=4b0e6cdb4c6ae4b9f3f35b8e\u0026amp;signature=5becdec091e53b83a2bc31090f570b02d1253482876b8e67b26e6033c9cf292e\">\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=\"Reference - ZappWay - Connect custom data to large language models\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Reference\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zappway.mintlify.site/_mintlify/api/og/v2?division=Form\u0026amp;title=Reference\u0026amp;description=Reference\u0026amp;theme=4b0e6cdb4c6ae4b9f3f35b8e\u0026amp;signature=5becdec091e53b83a2bc31090f570b02d1253482876b8e67b26e6033c9cf292e\">\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/zappway/nA6plCD2-OvUMbgI/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ZappWay - Connect custom data to large language models\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#009a7e\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.zappway.ai/en/widgets/form/reference\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/widgets/form/reference.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.zappway.ai/en/widgets/form/reference\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://docs.zappway.ai/pt-BR/widgets/form/reference\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.zappway.ai/es/widgets/form/reference\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.zappway.ai/en/widgets/form/reference\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.zappway.ai/#organization\",\"name\":\"ZappWay - Connect custom data to large language models\",\"url\":\"https://docs.zappway.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/zappway/NtpMWDbmNmYF-G-B/logo/light.png?fit=max\u0026auto=format\u0026n=NtpMWDbmNmYF-G-B\u0026q=85\u0026s=f65c869bd80f023f03cdca82742ccd6c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.zappway.ai#website\",\"name\":\"ZappWay - Connect custom data to large language models\",\"url\":\"https://docs.zappway.ai\",\"publisher\":{\"@id\":\"https://docs.zappway.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.zappway.ai/en/widgets/form/reference#webpage\",\"url\":\"https://docs.zappway.ai/en/widgets/form/reference\",\"name\":\"Reference\",\"description\":\"Reference\",\"dateModified\":\"2026-09-09T04:59:59.194Z\",\"isPartOf\":{\"@id\":\"https://docs.zappway.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.zappway.ai/en/widgets/form/reference#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.zappway.ai/en/widgets/form/reference#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Widgets\",\"item\":\"https://docs.zappway.ai/en/widgets/chatbot/bubble\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Form\",\"item\":\"https://docs.zappway.ai/en/widgets/form/hosted-form\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Reference\",\"item\":\"https://docs.zappway.ai/en/widgets/form/reference\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.zappway.ai/en/widgets/form/reference#article\",\"headline\":\"Reference\",\"name\":\"Reference\",\"description\":\"Reference\",\"url\":\"https://docs.zappway.ai/en/widgets/form/reference\",\"mainEntityOfPage\":{\"@id\":\"https://docs.zappway.ai/en/widgets/form/reference#webpage\"},\"dateModified\":\"2026-09-09T04:59:59.194Z\",\"publisher\":{\"@id\":\"https://docs.zappway.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.zappway.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ZappWay - Connect custom data to large language models\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"ZappWay - Connect custom data to large language models\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/en/widgets/form/reference.md","siteName":"ZappWay - Connect custom data to large language models","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Overview","icon":"bars-staggered","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","icon":"book-open","iconType":"solid","href":"/en/introduction"},{"title":"Platform Architecture","icon":"layer-group","iconType":"duotone","href":"/en/platform"}]},{"group":"Workspace","pages":[{"title":"User Profile","icon":"user","href":"/en/settings/profile"},{"title":"Team \u0026 Organization","icon":"users-gear","href":"/en/settings/team"},{"title":"Billing \u0026 Plans","icon":"credit-card","href":"/en/settings/billing"},{"title":"Contact Management","icon":"users","href":"/en/contacts/overview"},{"title":"API Keys","icon":"key","href":"/en/settings/api-keys"}]},{"group":"ZappFlux Automation","pages":[{"title":"ZappFlux","icon":"bolt","href":"/en/zappflux/overview"},{"title":"Iframe Integration","icon":"window-restore","href":"/en/zappflux/iframe-integration"},{"title":"Building Flows","icon":"diagram-project","href":"/en/zappflux/flows"},{"title":"Flow Settings","icon":"sliders","href":"/en/zappflux/settings"}]}]},{"tab":"AI Employee","icon":"teamspeak","groups":[{"group":"AI Employee","pages":[{"title":"AI Employee","icon":"teamspeak","href":"/en/agent/get-started"},{"group":"Tools","pages":[{"title":null,"href":"/en/agent/tools/quick-start"},{"title":null,"href":"/en/agent/tools/datastore-tool"},{"title":"HTTP Tool","href":"/en/agent/tools/http-tool"},{"title":null,"href":"/en/agent/tools/form-tool"},{"title":null,"href":"/en/agent/tools/request-human-tool"},{"title":null,"href":"/en/agent/tools/mark-as-resolved-tool"},{"title":null,"href":"/en/agent/tools/lead-generation-tool"}]},{"group":"ZappFlux","pages":[{"title":"ZappFlux","icon":"bolt","href":"/en/agent/zappflux/overview"},{"title":"Iframe Integration","icon":"window-restore","href":"/en/agent/zappflux/iframe-integration"},{"title":"Building Flows","icon":"diagram-project","href":"/en/agent/zappflux/flows"},{"title":"Flow Settings","icon":"sliders","href":"/en/agent/zappflux/settings"}]},{"title":null,"href":"/en/agent/human-handoff"},{"title":null,"href":"/en/agent/fine-tuning"},{"title":null,"href":"/en/agent/conversation-file-upload"},{"title":null,"href":"/en/agent/answer-sources"},{"title":null,"href":"/en/agent/message-suggestions"},{"title":null,"href":"/en/agent/optimize-ai-answers"},{"title":null,"href":"/en/agent/rate-limit"},{"title":null,"href":"/en/agent/debug"}]}]},{"tab":"Datastore","icon":"database","groups":[{"group":"Datastore","pages":[{"title":"Datastores","icon":"database","href":"/en/datastore/get-started"},{"title":"Datasources","icon":"file-lines","href":"/en/datastore/datasources"}]},{"group":"Train With","pages":[{"group":"Cloud Storage","pages":[{"title":"Google Drive","icon":"google-drive","href":"/en/datastore/train/google-drive"},{"title":"Notion","icon":"n","href":"/en/datastore/train/notion"}]},{"group":"Microsoft Office","pages":[{"title":"Word Documents","icon":"file-word","href":"/en/datastore/train/word"},{"title":"Excel Spreadsheets","icon":"file-excel","href":"/en/datastore/train/excel"},{"title":"PowerPoint Presentations","icon":"file-powerpoint","href":"/en/datastore/train/powerpoint"}]},{"group":"Documents","pages":[{"title":"PDF Documents","icon":"file-pdf","href":"/en/datastore/train/pdf"},{"title":"Text Files","icon":"file-lines","href":"/en/datastore/train/text-files"}]},{"group":"Web Content","pages":[{"title":"Website Single Page","icon":"globe","href":"/en/datastore/train/website-single-page"},{"title":"Website Full Crawl","icon":"sitemap","href":"/en/datastore/train/website-full-crawl"},{"title":"YouTube Videos","icon":"youtube","href":"/en/datastore/train/youtube"}]}]}]},{"tab":"Train With","icon":"cloud-bolt","groups":[{"group":"Cloud Storage","pages":[{"title":"Google Drive","icon":"google-drive","href":"/en/train/google-drive"},{"title":"Notion","icon":"n","href":"/en/train/notion"}]},{"group":"Microsoft Office","pages":[{"title":"Word Documents","icon":"file-word","href":"/en/train/word"},{"title":"Excel Spreadsheets","icon":"file-excel","href":"/en/train/excel"},{"title":"PowerPoint Presentations","icon":"file-powerpoint","href":"/en/train/powerpoint"}]},{"group":"Documents","pages":[{"title":"PDF Documents","icon":"file-pdf","href":"/en/train/pdf"},{"title":"Text Files","icon":"file-lines","href":"/en/train/text-files"}]},{"group":"Web Content","pages":[{"title":"Website Single Page","icon":"globe","href":"/en/train/website-single-page"},{"title":"Website Full Crawl","icon":"sitemap","href":"/en/train/website-full-crawl"},{"title":"YouTube Videos","icon":"youtube","href":"/en/train/youtube"}]}]},{"tab":"Form","icon":"file-lines","groups":[{"group":"Form","pages":[{"title":"Forms","icon":"file-lines","href":"/en/form/get-started"}]}]},{"tab":"Email Inbox","icon":"envelope","groups":[{"group":"Email Inbox","pages":[{"title":"Email Inbox","icon":"envelope","href":"/en/email-inbox/get-started"},{"group":"Setup","pages":[{"title":null,"href":"/en/email-inbox/gmail"},{"title":null,"href":"/en/email-inbox/outlook"},{"title":null,"href":"/en/email-inbox/yahoo"}]}]}]},{"tab":"Integrations","icon":"share-nodes","groups":[{"group":"Integrations","pages":[{"group":"🚀 Install On","pages":[{"title":"WhatsApp","icon":"whatsapp","href":"/en/integrations/whatsapp"},{"title":"WhatsApp Business","icon":"message-dollar","href":"/en/integrations/whatsapp-business"},{"title":"Instagram","icon":"instagram","href":"/en/integrations/instagram"},{"title":"Messenger","icon":"facebook-messenger","href":"/en/integrations/messenger"},{"title":"Telegram","icon":"telegram","href":"/en/integrations/telegram"},{"title":"Shopify","icon":"shopify","href":"/en/integrations/shopify"},{"title":"Website","icon":"globe","href":"/en/integrations/website"},{"title":"WordPress","icon":"wordpress","href":"/en/integrations/wordpress"},{"title":"Slack","icon":"slack","href":"/en/integrations/slack"},{"title":"Zapier","icon":"bolt","href":"/en/integrations/zapier"},{"title":"Crisp","icon":"comment-dots","href":"/en/integrations/crisp"}]},{"group":"External Integrations","pages":[{"title":"Langchain","href":"/en/integrations/langchain"}]}]}]},{"tab":"Widgets","icon":"shuffle","groups":[{"group":"Widgets","pages":[{"group":"Chatbot","pages":[{"title":"Bubble","href":"/en/widgets/chatbot/bubble"},{"title":"Standard","href":"/en/widgets/chatbot/standard"},{"title":null,"href":"/en/widgets/chatbot/reference"}]},{"group":"Form","pages":[{"title":null,"href":"/en/widgets/form/hosted-form"},{"title":"Standard Widget","href":"/en/widgets/form/standard"},{"title":null,"href":"/en/widgets/form/usage-with-chatbot"},{"description":"Form Fields","title":null,"href":"/en/widgets/form/fields"},{"title":null,"href":"/en/widgets/form/reference"}]}]}]},{"tab":"Analytics","icon":"analytics","pages":[{"title":"Analytics","description":"The Analytics page is designed to provide users with comprehensive insights into their AI Employee performance.","icon":"analytics","href":"/en/analytics/get-started"},{"title":"Omnichannel","icon":"inbox","href":"/en/logs/overview"}]},{"tab":"API Reference","icon":"terminal","groups":[{"group":"API Reference","pages":[{"title":"Authentication","href":"/en/api-reference/authentication"},{"group":"Agents","pages":[{"title":"AI Employee - Query","openapi":"POST /agents/{id}/query","href":"/en/api-reference/endpoint/agents/query"},{"title":"AI Employee - Create","openapi":"POST /agents","href":"/en/api-reference/endpoint/agents/create"},{"title":"AI Employee - Get","openapi":"GET /agents/{id}","href":"/en/api-reference/endpoint/agents/get"},{"title":"AI Employee - Update","openapi":"PATCH /agents/{id}","href":"/en/api-reference/endpoint/agents/update"},{"title":"AI Employee - Delete","openapi":"DELETE /agents/{id}","href":"/en/api-reference/endpoint/agents/delete"}]},{"group":"Datastores","pages":[{"title":"Datastore - Query","openapi":"POST /datastores/{id}/query","href":"/en/api-reference/endpoint/datastores/query"},{"title":"Datastore - Create","openapi":"POST /datastores","href":"/en/api-reference/endpoint/datastores/create"},{"title":"Datastore - Get","openapi":"GET /datastores/{id}","href":"/en/api-reference/endpoint/datastores/get"},{"title":"Datastore - Update","openapi":"PATCH /datastores/{id}","href":"/en/api-reference/endpoint/datastores/update"},{"title":"Datastore - Delete","openapi":"DELETE /datastores/{id}","href":"/en/api-reference/endpoint/datastores/delete"},{"title":"Datasource - Upsert (⚠️ deprecated)","api":"POST https://app.zappway.ai/api/datastores/upsert/{datastoreId}","href":"/en/api-reference/endpoint/datastores/upsert"},{"title":"Datasource - File Upload (⚠️ deprecated)","api":"POST http://localhost:3000/api/external/datastores/file-upload/{datastoreId}","href":"/en/api-reference/endpoint/datastores/file-upload"}]},{"group":"Datasources","pages":[{"title":"Datasource - Create","openapi":"POST /datasources","href":"/en/api-reference/endpoint/datasources/create"},{"title":"Datasource - Get","openapi":"GET /datasources/{id}","href":"/en/api-reference/endpoint/datasources/get"},{"title":"Datasource - Update (⚠️ deprecated)","api":"POST https://app.zappway.ai/api/datastores/update/{datastoreId}","href":"/en/api-reference/endpoint/datasources/update"},{"title":"Datasource - Delete","openapi":"DELETE /datasources/{id}","href":"/en/api-reference/endpoint/datasources/delete"}]}]}]},{"tab":"AI Features","icon":"wand-magic-sparkles","groups":[{"group":"Agent Skills","pages":[{"title":"Agent Skills","icon":"wand-magic-sparkles","iconType":"duotone","href":"/en/agent-skills"}]},{"group":"Agent Cortex","pages":[{"title":"Agent Cortex","icon":"brain-circuit","iconType":"duotone","href":"/en/agent-cortex/index"},{"title":"Cognitive Strategy","href":"/en/cognitive-strategy/index"},{"title":"Cognitive Strategy runtime","href":"/en/internal_for_dev's/cognitive-strategy/index"}]},{"group":"Livia - 360 Assistant","pages":[{"title":"Livia - 360 Assistant","icon":"user-astronaut","iconType":"duotone","href":"/en/personal-assistant/overview"}]},{"group":"Conversations","pages":[{"title":"Conversations","icon":"messages","iconType":"duotone","href":"/en/conversations/overview"}]},{"group":"VoiceFlux","pages":[{"title":"VoiceFlux","icon":"waveform","href":"/en/voiceflux/index"}]},{"group":"Access Groups","pages":[{"title":"Access Groups","icon":"shield-halved","iconType":"duotone","href":"/en/access-groups/overview"}]}]},{"tab":"Privacy","icon":"shield-halved","groups":[{"group":"Privacy \u0026 Legal","pages":[{"title":"GDPR / LGPD Compliance","icon":"shield-halved","href":"/en/privacy/gdpr"},{"title":"Privacy Policy","icon":"shield-halved","href":"/en/privacy/privacy-policy"},{"title":"Terms of Service","icon":"shield-halved","href":"/en/privacy/terms"}]}]}]},{"language":"pt-BR","pages":[{"title":"pt-BR","href":"/pt-BR/introduction"}]},{"language":"es","pages":[{"title":"es","href":"/es/introduction"}]}]},"basePath":"","title":"Reference - ZappWay - Connect custom data to large language models","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":[],"chunks":[]}