hotglue Docs

API Reference

Unified API Schemas

Dashboard

Status

Check the status of a running discover. If empty, no discover is currently running.

Poll Discover

sec0

The ETL platform to build the integrations your customers want

Introduction

Welcome to hotglue

Get answers to all your questions on hotglue.

What hotglue environments are, and how to use them

Environments

Flows

Sources

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

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

Changelog

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

Writing a basic script

Debugging a script

Snapshots

Sample Scripts

Learn how to build custom targets using the Singer SDK

Building targets

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

Tenants

Start making requests to the hotglue API!

Secure Requests

The following endpoints apply for V1, one-way flows

Kicks off a job for a given tenant. When using the API tap, you can pass a payload in the `state` object to be written to the target.

Run a V1 job

The following section applies to V2 bi-directional flows.

Kicks off a job for a given tenant. Can be used to write data in target flows by passing a payload in the state object.

Run a V2 Job

Write data using our [unified schemas](https://hotglue.com/docs/unified) directly to integrations in real-time. Note: this feature is in beta with limited support.

Send unified data to a connector

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

Tenant Metadata

Subtenants

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

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

A Python library for efficient ETL processes, optimized for hotglue

Introduction to Gluestick

Read Data

Data Reading Functions

Snapshotting

Snapshotting functions

Functions for processing and transforming JSON and object data in pandas DataFrames

JSON & Object Handling

Functions for cleaning, mapping, and transforming data in pandas DataFrames

Data Transformation

Data Transformation Functions

Functions for exporting data to various formats and handling errors in ETL pipelines

Export Data

Data Export & Error Handling

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

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

hotglue API

V1 - One Way Flows

V2 - Two Way Flows

BETA - Real-time Write

Poll Discover

Authorizations

Path Parameters

Query Parameters

Response