This is your public or private API key, depending on the sensitivity of your request. It can be found in the hotglue panel, under the settings page. By default, this is global to all your hotglue environments.Learn more about authenticating to the hotglue API.
If you’re working with a specific flow, you will need to know its ID. This is available in the URL when you’re in a specific flow, or can be requested via API.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"hotglue Docs","colors":{"primary":"#FA5240","light":"#FA5240","dark":"#0D001D"},"logo":{"light":"https://mintcdn.com/hotglue/93ZiEPSb_fe30f8U/logo/light.svg?fit=max\u0026auto=format\u0026n=93ZiEPSb_fe30f8U\u0026q=85\u0026s=d6da8a743c519a664de97ec2f17bbe47","dark":"https://mintcdn.com/hotglue/93ZiEPSb_fe30f8U/logo/dark.svg?fit=max\u0026auto=format\u0026n=93ZiEPSb_fe30f8U\u0026q=85\u0026s=f60f3face71611a2985a6e4e4dbe28b0"},"favicon":"https://mintcdn.com/hotglue/5Ve6qyQIr-eWU9BP/favicon.png?fit=max\u0026auto=format\u0026n=5Ve6qyQIr-eWU9BP\u0026q=85\u0026s=d69376acad4420dc613eb4cfef299453","api":{"openapi":"openapi.json"},"appearance":{"default":"dark","strict":true},"background":{"color":{"dark":"#0f1117"}},"navbar":{"links":[{"href":"https://status.hotglue.xyz/","label":"Status"}],"primary":{"type":"button","label":"Dashboard","href":"https://hotglue.com/dashboard"}},"footer":{"socials":{"twitter":"https://twitter.com/hotgluexyz","github":"https://github.com/hotgluexyz","linkedin":"https://www.linkedin.com/company/hotglue"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hotglue","hasAudioNarration":false,"actualSubdomain":"hotglue","customDomains":["docs.hotglue.com"],"gitSource":{"type":"github","owner":"hotgluexyz","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae89e67a2a5e46fe1789c7d","collectionId":"3ad1b60a-161f-4502-8a2e-b195e2fca4ac","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae89e67a2a5e46fe1789c7d"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae8e8156384574846e0d9da","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Documentation","count":310},{"language":"default","tag":"Connectors","count":243},{"language":"default","tag":"Community Connectors","count":177},{"language":"default","tag":"API Reference","count":83},{"language":"default","tag":"Embedded Widget","count":68},{"language":"default","tag":"Core Connectors","count":47},{"language":"default","tag":"hotglue API","count":32},{"language":"default","tag":"Key Concepts","count":25},{"language":"default","tag":"Transformation","count":25},{"language":"default","tag":"V1 flows (legacy)","count":21}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/overview","slug":"/api-reference/overview","pageMetadata":{"title":"Overview","description":"Start making requests to the hotglue API!","href":"/api-reference/overview"},"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: \"Start making requests to the hotglue API!\"\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={a:`a`,p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`To start using the hotglue API, make sure you have the following handy`}),`\n`,_jsx(Heading,{level:`2`,id:`environment-id`,children:`Environment ID`}),`\n`,_jsx(Heading,{level:`3`,id:`env_id`,children:`(env_id)`}),`\n`,_jsx(_components.p,{children:`This is the ID of your hotglue environment. It can be found in the hotglue panel, under the settings page.`}),`\n`,_jsx(Heading,{level:`2`,id:`api-key`,children:`API Key`}),`\n`,_jsx(Heading,{level:`3`,id:`x-api-key`,children:`(x-api-key)`}),`\n`,_jsx(_components.p,{children:`This is your public or private API key, depending on the sensitivity of your request. It can be found in the hotglue panel, under the settings page. By default, this is global to all your hotglue environments.`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/api-reference/authentication`,children:`Learn more`}),` about authenticating to the hotglue API.`]}),`\n`,_jsx(Heading,{level:`2`,id:`flow-id`,children:`Flow ID`}),`\n`,_jsx(Heading,{level:`3`,id:`flow_id`,children:`(flow_id)`}),`\n`,_jsx(_components.p,{children:`If you’re working with a specific flow, you will need to know its ID. This is available in the URL when you’re in a specific flow, or can be requested via 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":"Overview","description":"Start making requests to the hotglue API!","href":"/api-reference/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Environment ID","slug":"environment-id","depth":2,"children":[{"title":"(env_id)","slug":"env_id","depth":3,"children":[]}]},{"title":"API Key","slug":"api-key","depth":2,"children":[{"title":"(x-api-key)","slug":"x-api-key","depth":3,"children":[]}]},{"title":"Flow ID","slug":"flow-id","depth":2,"children":[{"title":"(flow_id)","slug":"flow_id","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"hotglue","siteName":"hotglue Docs","title":"Overview - hotglue Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-17T21:44:24.357Z","originalFileLocation":"api-reference/overview.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"dark\";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=\"dark\"}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=\"Start making requests to the hotglue API!\">\u003cmeta data-mint-head name=\"application-name\" content=\"hotglue Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hotglue/0VcZrfJjkH6v2iGG/_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/hotglue/0VcZrfJjkH6v2iGG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hotglue/0VcZrfJjkH6v2iGG/_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/hotglue/0VcZrfJjkH6v2iGG/_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/hotglue/0VcZrfJjkH6v2iGG/_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/hotglue/0VcZrfJjkH6v2iGG/_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/hotglue/0VcZrfJjkH6v2iGG/_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/hotglue/0VcZrfJjkH6v2iGG/_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/hotglue/0VcZrfJjkH6v2iGG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Overview - hotglue Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Start making requests to the hotglue API!\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"hotglue Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hotglue.com/api-reference/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hotglue.mintlify.app/_mintlify/api/og/v2?division=hotglue+API\u0026amp;title=Overview\u0026amp;description=Start+making+requests+to+the+hotglue+API%21\u0026amp;theme=6f74925a605d4b403769e9ea\u0026amp;signature=d8cc65e1fc3378736a4448c2103bffef1581a6f11d59feca70d183d0d93680ec\">\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=\"Overview - hotglue Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Start making requests to the hotglue API!\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hotglue.mintlify.app/_mintlify/api/og/v2?division=hotglue+API\u0026amp;title=Overview\u0026amp;description=Start+making+requests+to+the+hotglue+API%21\u0026amp;theme=6f74925a605d4b403769e9ea\u0026amp;signature=d8cc65e1fc3378736a4448c2103bffef1581a6f11d59feca70d183d0d93680ec\">\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/hotglue/0VcZrfJjkH6v2iGG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"hotglue Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FA5240\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hotglue.com/api-reference/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hotglue.com/#organization\",\"name\":\"hotglue Docs\",\"url\":\"https://docs.hotglue.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hotglue/93ZiEPSb_fe30f8U/logo/light.svg?fit=max\u0026auto=format\u0026n=93ZiEPSb_fe30f8U\u0026q=85\u0026s=d6da8a743c519a664de97ec2f17bbe47\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hotglue.com#website\",\"name\":\"hotglue Docs\",\"url\":\"https://docs.hotglue.com\",\"publisher\":{\"@id\":\"https://docs.hotglue.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hotglue.com/api-reference/overview#webpage\",\"url\":\"https://docs.hotglue.com/api-reference/overview\",\"name\":\"Overview\",\"description\":\"Start making requests to the hotglue API!\",\"dateModified\":\"2026-02-17T21:44:24.357Z\",\"isPartOf\":{\"@id\":\"https://docs.hotglue.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hotglue.com/api-reference/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hotglue.com/api-reference/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"hotglue Docs\",\"item\":\"https://docs.hotglue.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Overview\",\"item\":\"https://docs.hotglue.com/api-reference/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.hotglue.com/api-reference/overview#article\",\"headline\":\"Overview\",\"name\":\"Overview\",\"description\":\"Start making requests to the hotglue API!\",\"url\":\"https://docs.hotglue.com/api-reference/overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hotglue.com/api-reference/overview#webpage\"},\"dateModified\":\"2026-02-17T21:44:24.357Z\",\"publisher\":{\"@id\":\"https://docs.hotglue.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hotglue.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"hotglue Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"hotglue Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"hotglue API","pages":[{"title":"Overview","href":"/api-reference/overview"},{"title":"Authentication","description":null,"href":"/api-reference/authentication"},{"group":"Manage Tenants","pages":[{"openapi":"get /tenants/{env_id}","title":"Retrieve tenants","href":"/api-reference/manage-tenants/retrieve-tenants"},{"openapi":"put /tenants/{env_id}/schedule","title":"Toggle schedule","href":"/api-reference/manage-tenants/toggle-schedule"},{"openapi":"delete /tenant/{env_id}/{tenant}","title":"Delete a tenant","href":"/api-reference/manage-tenants/delete-a-tenant"},{"openapi":"put /tenant/{env_id}/{tenant}/metadata","title":"Set tenant metadata","href":"/api-reference/manage-tenants/set-tenant-metadata"},{"openapi":"get /tenant/{env_id}/{tenant}/mapping","title":"Get tenant mapping","href":"/api-reference/manage-tenants/get-tenant-mapping"},{"openapi":"put /tenant/{env_id}/{tenant}/mapping","title":"Set tenant mapping","href":"/api-reference/manage-tenants/set-tenant-mapping"},{"openapi":"post /{env_id}/magicLink","title":"Create a Magic Link","href":"/api-reference/manage-tenants/create-magic-link"},{"group":"Snapshots","pages":[{"openapi":"get /tenant/{env_id}/{tenant}/snapshots","title":"Get Snapshots","href":"/api-reference/manage-tenants/get-snapshot"},{"openapi":"delete /tenant/{env_id}/{tenant}/snapshots","title":"Delete Snapshot","href":"/api-reference/manage-tenants/delete-snapshot"}]},{"group":"Tenant Config","pages":[{"openapi":"get /tenant/{env_id}/{tenant}/config","title":"Get tenant config","href":"/api-reference/manage-tenants/get-tenant-config"},{"openapi":"put /tenant/{env_id}/{tenant}/config","title":"Set tenant config","href":"/api-reference/manage-tenants/set-tenant-config"},{"openapi":"patch /tenant/{env_id}/{tenant}/config","title":"Update tenant config","href":"/api-reference/manage-tenants/update-tenant-config"}]}]},{"group":"Flows","pages":[{"openapi":"post /{env_id}/flows/linked","title":"Create linked flows","href":"/api-reference/flows/create-linked-flows"},{"openapi":"get /{env_id}/flows/linked","title":"Retrieve linked flows","href":"/api-reference/flows/retrieve-linked-flows"},{"openapi":"get /{env_id}/flows/supported","title":"Retrieve supported flows","href":"/api-reference/flows/retrieve-supported-flows"}]},{"group":"Jobs","pages":[{"openapi":"get /{env_id}/{flow_id}/{tenant}/jobs/status","title":"Poll job status","href":"/api-reference/jobs/poll-job-status"},{"openapi":"get /{env_id}/{flow_id}/{tenant}/jobs/latest","title":"Get latest job","href":"/api-reference/jobs/get-latest-job"},{"openapi":"post /{env_id}/{flow_id}/{tenant}/jobs/rollback","title":"Rollback job","href":"/api-reference/jobs/rollback-job"},{"openapi":"post /{env_id}/{flow_id}/{tenant}/jobs/kill","title":"Kill job","href":"/api-reference/jobs/kill-job"},{"openapi":"get /{env_id}/{flow_id}/{tenant}/jobs","title":"Fetch jobs","href":"/api-reference/jobs/fetch-jobs"},{"openapi":"get /{env_id}/{flow}/{user_id}/jobs/queued","title":"Fetch queued jobs","href":"/api-reference/jobs/fetch-queued-jobs"},{"openapi":"get /{env_id}/jobs/queued","title":"Fetch environment queued jobs","href":"/api-reference/jobs/fetch-environment-queued-jobs"},{"openapi":"delete /{env_id}/{flow}/{user_id}/jobs/queued/{queued_job_id}","title":"Cancel queued job","href":"/api-reference/jobs/cancel-queued-job"},{"openapi":"get /{env_id}/{flow_id}/{tenant}/jobs/download","title":"Trigger download","href":"/api-reference/jobs/trigger-download"},{"openapi":"get /{env_id}/{flow_id}/{tenant}/jobs/zip","title":"Fetch job zip","href":"/api-reference/jobs/fetch-job-zip"},{"openapi":"post /{env_id}/{flow}/{tenant_id}/jobs/retrigger","title":"Retrigger a job","href":"/api-reference/jobs/retrigger-job"},{"openapi":"post /{env_id}/{flow}/{user_id}/connectors/api/uploads/url","title":"Stage data for write jobs","href":"/api-reference/jobs/generate-upload-url"}]},{"group":"Schedule jobs","pages":[{"openapi":"get /{env_id}/{flow_id}/{tenant}/jobs/schedule","title":"Retrieve jobs schedule","href":"/api-reference/schedule-jobs/retrieve-jobs-schedule"},{"openapi":"put /{env_id}/{flow_id}/{tenant}/jobs/schedule","title":"Create jobs schedule","href":"/api-reference/schedule-jobs/create-jobs-schedule"},{"openapi":"delete /{env_id}/{flow_id}/{tenant}/jobs/schedule","title":"Delete jobs schedule","href":"/api-reference/schedule-jobs/delete-jobs-schedule"}]}]},{"group":"V1 flows (legacy)","pages":[{"title":"Introduction","href":"/api-reference/v1/introduction"},{"openapi":"post /{env_id}/{flow_id}/{tenant}/jobs","title":"Run a V1 job","href":"/api-reference/v1/jobs/run-job"},{"group":"Source metadata","pages":[{"openapi":"get /{env_id}/{flow_id}/supportedSources","title":"Supported sources","href":"/api-reference/v1/source-metadata/supported-sources"},{"openapi":"get /{env_id}/availableSources","title":"Available sources","href":"/api-reference/v1/source-metadata/available-sources"}]},{"group":"Target metadata","pages":[{"openapi":"get /{env_id}/{flow_id}/supportedTargets","title":"Supported targets","href":"/api-reference/v1/target-metadata/supported-targets"},{"openapi":"get /{env_id}/availableTargets","title":"Available targets","href":"/api-reference/v1/target-metadata/available-targets"}]},{"group":"Linked sources","pages":[{"openapi":"post /{env_id}/{flow_id}/{tenant}/linkedSources","title":"Link a source","href":"/api-reference/v1/linked-sources/link-a-source"},{"openapi":"delete /{env_id}/{flow_id}/{tenant}/linkedSources","title":"Unlink a source","href":"/api-reference/v1/linked-sources/unlink-a-source"},{"openapi":"get /{env_id}/{flow_id}/{tenant}/linkedSources","title":"Retrieve linked source","href":"/api-reference/v1/linked-sources/retrieve-linked-source"},{"openapi":"patch /{env_id}/{flow_id}/{tenant}/linkedSources","title":"Update linked sources","href":"/api-reference/v1/linked-sources/update-linked-sources"},{"openapi":"get /{env_id}/{flow_id}/{tenant}/linkedSources/discover","title":"Run Discover","href":"/api-reference/v1/linked-sources/run-discover"},{"openapi":"get /{env_id}/{flow_id}/{tenant}/linkedSources/discover/poll","title":"Poll Discover","href":"/api-reference/v1/linked-sources/poll-discover"},{"openapi":"get /{env_id}/{flow_id}/{tenant}/linkedConnectors/discover/kill","title":null,"href":"/api-reference/v1/linked-sources/kill-discover"}]},{"group":"Linked sources state","pages":[{"openapi":"get /{env_id}/{flow_id}/{tenant}/linkedSources/state","title":"Retrieve source state","href":"/api-reference/v1/linked-sources-state/retrieve-source-state"},{"openapi":"put /{env_id}/{flow_id}/{tenant}/linkedSources/state","title":"Set source state","href":"/api-reference/v1/linked-sources-state/set-source-state"},{"openapi":"delete /{env_id}/{flow_id}/{tenant}/linkedSources/state","title":"Delete source state","href":"/api-reference/v1/linked-sources-state/delete-source-state"}]},{"group":"Linked targets","pages":[{"openapi":"post /{env_id}/{flow_id}/{tenant}/linkedTargets","title":"Link a target","href":"/api-reference/v1/linked-targets/link-a-target"},{"openapi":"delete /{env_id}/{flow_id}/{tenant}/linkedTargets","title":"Unlink a target","href":"/api-reference/v1/linked-targets/unlink-a-target"},{"openapi":"patch /{env_id}/{flow_id}/{tenant}/linkedTargets","title":"Update a linked target","href":"/api-reference/v1/linked-targets/update-linked-target"},{"openapi":"get /{env_id}/{flow_id}/{tenant}/linkedTargets","title":"Retrieve linked target","href":"/api-reference/v1/linked-targets/retrieve-linked-target"},{"openapi":"get /{env_id}/{flow_id}/{tenant}/linkedTargets/discover","title":"Run Discover","href":"/api-reference/v1/linked-targets/run-discover"}]}]},{"group":"V2 Flows","pages":[{"title":"Introduction","href":"/api-reference/v2/introduction"},{"openapi":"post /v2/{env_id}/{flow_id}/{tenant}/jobs","title":"Run a V2 Job","href":"/api-reference/v2/jobs/create"},{"group":"Supported and available connectors","pages":[{"openapi":"get /v2/{env_id}/{flow_id}/supportedConnectors","title":"Retrieve supported connectors","href":"/api-reference/v2/connector-metadata/retrieve-supported-connectors"},{"openapi":"get /v2/{env_id}/availableConnectors","title":"Retrieve available connectors","href":"/api-reference/v2/connector-metadata/retrieve-available-connectors"}]},{"group":"Linked connectors","pages":[{"openapi":"get /v2/{env_id}/{flow_id}/{tenant}/linkedConnectors","title":"Retrieve linked connector","href":"/api-reference/v2/linked-connectors/get"},{"openapi":"post /v2/{env_id}/{flow_id}/{tenant}/linkedConnectors","title":"Link a connector","href":"/api-reference/v2/linked-connectors/create"},{"openapi":"patch /v2/{env_id}/{flow_id}/{tenant}/linkedConnectors","title":"Update linked connectors","href":"/api-reference/v2/linked-connectors/update"},{"openapi":"delete /v2/{env_id}/{flow_id}/{tenant}/linkedConnectors","title":"Unlink connector","href":"/api-reference/v2/linked-connectors/delete"},{"openapi":"get /v2/{env_id}/{flow_id}/{tenant}/linkedConnectors/discover","title":"Run Discover","href":"/api-reference/v2/linked-connectors/trigger-discover"},{"openapi":"get /v2/{env_id}/{flow_id}/{tenant}/linkedConnectors/discover/poll","title":"Poll Discover","href":"/api-reference/v2/linked-connectors/poll-discover-status"}]},{"group":"Linked connectors state","pages":[{"openapi":"get /v2/{env_id}/{flow_id}/{tenant}/linkedConnectors/state","title":"Retrieve connector state","href":"/api-reference/v2/linked-connectors-state/retrieve-connector-state"},{"openapi":"put /v2/{env_id}/{flow_id}/{tenant}/linkedConnectors/state","title":"Set connector state","href":"/api-reference/v2/linked-connectors-state/set-connector-state"},{"openapi":"delete /v2/{env_id}/{flow_id}/{tenant}/linkedConnectors/state","title":"Delete connector state","href":"/api-reference/v2/linked-connectors-state/delete-connector-state"}]},{"group":"Linked sources","pages":[{"openapi":"get /v2/{env_id}/{flow_id}/{tenant}/linkedSources","title":"Get linked sources","href":"/api-reference/v2/linked-sources/get"},{"openapi":"patch /v2/{env_id}/{flow_id}/{tenant}/linkedSources","title":"Update linked source","href":"/api-reference/v2/linked-sources/update"},{"openapi":"delete /v2/{env_id}/{flow_id}/{tenant}/linkedSources","title":"Unlink a source","href":"/api-reference/v2/linked-sources/delete"}]},{"group":"Linked targets","pages":[{"openapi":"get /v2/{env_id}/{flow_id}/{tenant}/linkedTargets","title":"Get linked targets","href":"/api-reference/v2/linked-targets/get"},{"openapi":"patch /v2/{env_id}/{flow_id}/{tenant}/linkedTargets","title":"Update linked target","href":"/api-reference/v2/linked-targets/update"},{"openapi":"delete /v2/{env_id}/{flow_id}/{tenant}/linkedTargets","title":"Unlink a target","href":"/api-reference/v2/linked-targets/delete"}]}]},{"group":"Connectors","pages":[{"group":"Access Tokens","pages":[{"openapi":"get /{env_id}/{flow_id}/{tenant}/connectors/{connector_id}/accesstoken","title":"Retrieve access token","href":"/api-reference/access-tokens/retrieve-access-token"}]},{"group":"Custom stream filters","pages":[{"openapi":"get /{env_id}/{flow_id}/{tenant}/connectors/{connector_id}/selectedFilters","title":"Retrieve Connector Selected Filters","href":"/api-reference/stream-filters/get-selected-filters"},{"openapi":"get /{env_id}/{flow_id}/{tenant}/connectors/{connector_id}/availableFilters","title":"Retrieve Connector Available Filters","href":"/api-reference/stream-filters/get-available-filters"},{"openapi":"delete /{env_id}/{flow_id}/{tenant}/connectors/{connector_id}/selectedFilters","title":"Delete Connector Selected Filters","href":"/api-reference/stream-filters/delete-selected-filters"},{"openapi":"put /{env_id}/{flow_id}/{tenant}/connectors/{connector_id}/selectedFilters","title":"Save Connector Selected Filters","href":"/api-reference/stream-filters/put-selected-filters"}]},{"group":"Real-time write","pages":[{"openapi":"post /{env_id}/{flow_id}/{tenant}/connectors/{connector_id}/{stream}","title":"Write to a connector","href":"/api-reference/real-time/write"},{"openapi":"get /{env_id}/{flow_id}/{tenant}/connectors/status","title":"Poll write request","href":"/api-reference/real-time/status"}]},{"group":"Connector metadata","pages":[{"openapi":"get /{env_id}/{flow}/{user_id}/connectors/{connector_id}/metadata","title":"Retrieve connector metadata","href":"/api-reference/v2/connector-metadata/retrieve-connector-metadata"},{"openapi":"post /{env_id}/{flow}/{user_id}/connectors/{connector_id}/metadata/refresh","title":"Refresh connector metadata","href":"/api-reference/v2/connector-metadata/refresh-connector-metadata"},{"openapi":"get /{env_id}/{flow}/{user_id}/connectors/{connector_id}/metadata/poll","title":"Poll connector metadata refresh","href":"/api-reference/v2/connector-metadata/poll-connector-metadata"}]}]},{"group":"MCP","pages":[{"openapi":"get /{env_id}/{flow_id}/{tenant}/mcpToken","title":"Generate MCP token","href":"/api-reference/mcp/generate-mcp-token"}]}]},{"tab":"Embedded Widget","dropdowns":[{"dropdown":"Widget V3 (Beta)","icon":"3","groups":[{"group":"Embedded Widget","pages":[{"title":"Overview","icon":"eye","href":"/widget-v3/overview"},{"title":"Vanilla JS Setup","icon":"js","href":"/widget-v3/javascript"},{"title":"React Setup","icon":"react","href":"/widget-v3/react"},{"group":"Reference","icon":"book","pages":[{"title":"openWidget","href":"/widget-v3/reference/openWidget"},{"title":"link","href":"/widget-v3/reference/link"},{"title":"runJob","href":"/widget-v3/reference/runJob"},{"title":"getJobStatus","href":"/widget-v3/reference/getJobStatus"},{"title":"getSupportedConnectors","href":"/widget-v3/reference/getSupportedConnectors"},{"title":"setListeners","href":"/widget-v3/reference/setListeners"},{"title":"setLocalization","href":"/widget-v3/reference/setLocalization"},{"title":"helperText","href":"/widget-v3/reference/helperText"},{"title":"setCredentialsValidator","href":"/widget-v3/reference/setCredentialsValidator"},{"title":"Skip credential reuse flow","href":"/widget-v3/reference/skipCredentialsReuseFlows"},{"title":"hideBackButtons","href":"/widget-v3/reference/hideBackButtons"},{"title":"Connections","href":"/widget-v3/reference/connections"},{"title":"Field map editor","href":"/widget-v3/reference/fieldMapEditor"},{"title":"enableCustomMapping","href":"/widget-v3/reference/customMapping"},{"title":"Sync Schedules","href":"/widget-v3/reference/sync-schedule"}]}]}]},{"dropdown":"Widget V2 (Stable)","icon":"2","groups":[{"group":"Embedded Widget","pages":[{"title":"Overview","icon":"eye","href":"/connection-methods/embedded-widget/overview"},{"title":"Javascript Reference","icon":"js","href":"/connection-methods/embedded-widget/javascript"},{"group":"React Reference","icon":"atom","pages":[{"title":"Overview","href":"/connection-methods/embedded-widget/react/overview"},{"title":"Use the widget","href":"/connection-methods/embedded-widget/react/use-the-widget"},{"title":"HotglueConfig","href":"/connection-methods/embedded-widget/react/hotglue-config"},{"title":"Inline component","href":"/connection-methods/embedded-widget/react/inline-component"}]},{"group":"Options","icon":"sliders","pages":[{"title":"Allow multiple sources","href":"/connection-methods/embedded-widget/options/allow-multiple-sources"},{"title":"Custom Credential Validation","href":"/connection-methods/embedded-widget/options/custom-credential-validation"},{"title":"Create metadata","href":"/connection-methods/embedded-widget/options/create-metadata"},{"title":"Custom field mapping","href":"/connection-methods/embedded-widget/options/custom-field-mapping"},{"title":"Filter","href":"/connection-methods/embedded-widget/options/filter"},{"title":"Hide back buttons","href":"/connection-methods/embedded-widget/options/hide-back-buttons"},{"title":"Listeners","href":"/connection-methods/embedded-widget/options/listener"},{"title":"Localization","href":"/connection-methods/embedded-widget/options/override-default-text"},{"title":"Skip to flow","href":"/connection-methods/embedded-widget/options/skip-to-flow"}]},{"title":"Changelog","icon":"clock-rotate-left","href":"/connection-methods/embedded-widget/changelog"}]}]}]},{"tab":"Unified Schemas","href":"https://hotglue.com/docs/unified"}]},"basePath":"","title":"Overview - hotglue Docs","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":[],"chunks":[]}