Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hotglue.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Introduction to the widget

The hotglue widget is a white-labeled component that allows your users to integrate instantly, without leaving your app. You can embed the widget using a few lines of Javascript or React.

​
Installation (React)

​
Install the @hotglue/widget package

If your project is built in React, you can install the @hotglue/widget package. using npm 
npm install @hotglue/widget
or using yarn 
yarn add @hotglue/widget

​
Launch the widget

First you must include the HotglueConfig provider as a higher order component in your React app. For example, in index.js:
index.js

import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';
import HotglueConfig from '@hotglue/widget';

ReactDOM.render(
  <HotglueConfig
    config={{
      apiKey: 'your-public-environment-api-key',
      envId: 'your-env-id'
    }}
  >
    <App />
  </HotglueConfig>,
  document.getElementById('root')
);
Now you can launch the widget using the useHotglue hook:
App.js

import { useHotglue } from '@hotglue/widget';

const App = (props) => {
  const { openWidget } = useHotglue();

  return <div>
    <button onClick={() => openWidget("test-user")}>Open widget</button>
  </div>
}

export default App;
You can also use the Connections component if you want to use the widget inline rather than in a modal.

​
Installation (Next.js)

Just like above, begin by installing the @hotglue/widget package using npm 
npm install --save @hotglue/widget
or yarn 
yarn add @hotglue/widget
Import HotglueConfig on your page and configure it.
next.js

import dynamic from 'next/dynamic'
const HotglueConfig = dynamic(() => import('@hotglue/widget'), { ssr: false })
export default function Home() {
	return (
		<div className={styles.container}>
			<HotglueConfig
				config={{
					apiKey: 'ADCgzXQpsj2aaPwzaDX0p3a33M0pUS88kmlnVvwe',
					envId: 'dev.yjzx.hotglue.gmail.com'
				}}
				>
				<HomeComponent />
			</HotglueConfig>
		</div>
	)}
Create the HomeComponent. Inside of it you can launch the widget using the useHotglue hook:
next.js

import { useHotglue } from '@hotglue/widget'

const HomeComponent = (props, ref) => {
	const { openWidget } = useHotglue()
	
	const handleOpenWidget = (tenant) => {
		openWidget(tenant)
	}
	
	return (
		<div>
			<button onClick={() => handleOpenWidget('test-user')}>
				openWidget as test-user
			</button>
		</div>)
}

export default HomeComponent
You can also use the connections component.
next.js
import dynamic from 'next/dynamic'
const HotglueConfig = dynamic(() => import('@hotglue/widget'), { ssr: false })
import { Connections } from '@hotglue/widget'
export default function Home() {
	
	return (
		<div>
			<HotglueConfig
				config={{
					apiKey: 'ADCgzXQpsj2aaPwzaDX0p3a33M0pUS88kmlnVvwe',
					envId: 'dev.yjzx.hotglue.gmail.com',
				}}
				>
				<Connections tenant='test-user' />
			</HotglueConfig>
		</div>
	)
}

​
Installation (Vanilla JavaScript)

​
1. Call and mount the widget

The first step of embedding hotglue is to add the widget to your web app. Simply copy the code generated from the hotglue environment dashboard into your HTML head tag.
HTML
<script src="https://hotglue.xyz/widgetv2.js"></script>
<script>
    HotGlue.mount({
        "api_key": "YOUR-API-KEY",
        "env_id": "YOUR-ENV-ID"
    });
</script>
HTML
<script src="https://hotglue.xyz/widgetv2.js"></script>
<script>
    HotGlue.mount({
        "api_key": "YOUR-API-KEY",
        "env_id": "YOUR-ENV-ID"
    });
</script>

​
2. Launch the widget

Option 1 - HotGlue.link() Now that the hotglue widget is installed in your web app, open the widget by calling HotGlue.link(<tenant id>, <flow id>, <source>, <preloaded>, <options>). In the example below, we also use options to hide the back button and add a listener to close the widget once the source is successfully linked. 
<script>
    function launchHGSource() {
        // Set the tenantId, flowId, and sourceId variables below
        HotGlue.link(tenantId, flowId, sourceId, false, {
          hideBackButtons: true,
          listener: {
            onSourceLinked: () => {
              HotGlue.close();
            }
          }
        })
    }
</script>

<button onclick="launchHGSource()">
    <span>Open specific source</span>
</button>
Option 2 - HotGlue.open() Alternatively, you can open the widget “flows” menu by calling HotGlue.open(<tenant id>) 
<script>
    function launchHG() {
        // change "tenant-id" to the id of the current user
        HotGlue.open('test-user-id', {});
    }
</script>
<button onclick="launchHG()">
    <span>Open hotglue widget</span>
</button>