hotglue Docs

API Reference

Unified API Schemas

Dashboard

Status

Returns all flows in an environment and their connectors

Retrieve supported flows

sec0

Introduction

Get answers to all your questions on hotglue.

What hotglue environments are, and how to use them

Environments

Flows

Tenants

Map tenant IDs to names, plans, and other identifiers using metadata

Tenant Metadata

Subtenants

Sources

The `job_details.json` object describes metadata about a job. Each job lifecycle webhook will contain corresponding job details for that stage.

Job Details

Sync Jobs

Life Cycle

Scheduling

The hotglue widget allows you to offer native, inline integrations in your app with a few lines of code.

Overview

Using the hotglue widget with plain JavaScript

Javascript Reference

Use the widget

HotglueConfig

Inline component

Allows tenants to connect to multiple distinct connectors in the same flow

Allow multiple sources

Define tenant metadata like name, industry, or contact

Create metadata

Allow users to map their fields to your schema

Custom field mapping

Filter

Hides back buttons in widget. Usually used for the `link` function

Hide back buttons

Listener

`localization` overrides default headers, captions, and buttons in the widget

Override default text

Instead of showing a list of flows, `flow` will open to a specific flow

Skip to flow

This changelog documents the updates, enhancements, and bug fixes for the `@hotglue/widget` package.

Changelog

Learn how the unified schema works and how to use it.

Accounting Schema

E-Commerce Schema

CRM Schema

Widget settings

Fully white label your user OAuth experience

White-label

Set up job settings and webhook monitoring

Job settings

Integrate hotglue with your own workflow by configuring a webhook

Webhooks

Example overview page before API endpoints

Environment Variables

A brief overview of the hotglue CLI and installation options

Configuration

Jobs

This guide walks through writing a basic transform script using the gluestick package

Writing a basic script

Debugging a script

Snapshots

Handle advanced use cases in the transformation scripts

Use Cases

Learn how to use the transformation scripts to push data directly to your API

Push to APIs

How to add custom parameters to the hotglue widget

Custom Params

How to handle typing and primary keys with transformation scripts

Typing and Primary Keys

Sample Scripts

AWS Cognito

Abicart

Abra

ActiveCampaign

Affinity

Agile CRM

Altium 365

Amazon Ads

Amplitude

App Store Connect

AppsFlyer

Asana

Auth0

Azure Active Directory

Bexio

Blackbaud

Campaign Monitor

Capsule

Chargify

Cin7

ClickUp

Clockify

Close

Contentful

Copper

DearSystems

Delighted

Dotykacka

ECB Exchange Rates

Ecwid

Etsy

Eventbrite

Facebook Ads

Faire

Files

Firebase Auth

Firestore

Fishbowl Inventory

Fixer.io

Follow Up Boss

Fortnox

FreshBooks

Freshcaller

Freshsales Classic

Freshsales Suite

Front

Fulfil

Gambio

GitHub

GitLab

Gladly

GoHighLevel

Gong

Google Ads

Google Adwords

Google Analytics 4

Google Play

Google Workspace

Intercom

Invoiced

Iterable

Jira

Jotform

Judge.me

Katana MRP

Keap

Klaviyo

Kustomer

Linear

LiveChat

Looker

MYOB

Mailchimp

MailerLite

Mailgun

Mailjet

Mailshake

Mailstep

Marketplacer

Metronome

Microsoft Dynamics 365 Finance

Microsoft Dynamics On-Premise

Mixpanel

Monday.com

Montapacking

Moosend

Netohq

Notion

Omnisend

Ongoing WMS

Open Exchange Rates

Ordoro

Outreach

PagerDuty

PayPal

Picqer

PostHog

PowerBI

Precoro

Start making requests to the hotglue API!

Secure Requests

Returns a list of tenants that exist in an environment

Retrieve tenants

Disable, enable, and manage schedules across tenants in your environment

Toggle schedule

Delete all existing snapshots for a particular tenant

Learn more about snapshots [here](doc:snapshots).

Delete Snapshot

Delete all of a tenants data and optionally revoke OAuth connections

Delete a tenant

Gets the `tenant-config.json` from snapshots

Get tenant config

Creates a `tenant-config.json` that you can use to store custom settings, credentials, and metadata

Set tenant config

Update tenant config

Add metadata to your [Tenant Metadata](/key-concepts/tenants/metadata) object

Set tenant metadata

Create a Magic Link to allow tenants to link an integration.

Create a Magic Link

Create linked flows

Returns the flows that are currently linked for a specific tenant

Retrieve linked flows

Check on the status of a job, using the `job_root` returned by your initial Run Job call.

Poll job status

Fetch the most recent job for a given tenant in a given flow

Get latest job

Reset the the configuration to the state before a given job ran. This affects the `source state` (bookmarks) and the `snapshots`.

Rollback job

hotglue API

V1 - One Way Flows

V2 - Two Way Flows

BETA - Real-time Write

Retrieve supported flows

Authorizations

Path Parameters

Response