hotglue Docs

API Reference

Unified API Schemas

Dashboard

Changelog

Status

Retrieve jobs schedule

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

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

AWS S3

Abicart

Abra

ActiveCampaign

Affinity

Agile CRM

Airtable

Altium 365

Amazon Ads

Amazon Seller

Amazon Vendor Central

Amplitude

App Store Connect

AppsFlyer

Asana

Auth0

Azure Active Directory

Azure Blob Storage

Bexio

BigCommerce

BigQuery

Blackbaud

Campaign Monitor

Capsule

Chargebee

Chargify

Cin7

ClickUp

Clockify

Close

Contentful

Copper

DearSystems

Delighted

Dotykacka

ECB Exchange Rates

Ecwid

Etsy

Eventbrite

Exact

Facebook Ads

Faire

Files

Firebase Auth

Firestore

Fishbowl Inventory

Fixer.io

Follow Up Boss

Fortnox

FreshBooks

Freshcaller

Freshsales

Freshworks CRM

Front

Fulfil

Gambio

GitHub

GitLab

Gladly

GoHighLevel

Gong

Google Ads

Google Adwords

Google Analytics 4

Google Cloud Storage

Google Play

Google Sheets

Google Workspace

HubSpot

Intercom

Invoiced

Iterable

Jira

Jotform

Judge.me

Katana MRP

Keap

Klaviyo

Kustomer

Linear

LiveChat

Looker

MYOB

Magento 1

Magento 2

Mailchimp

MailerLite

Mailgun

Mailjet

Mailshake

Mailstep

Marketplacer

Metronome

Microsoft Dynamics 365

Microsoft Dynamics 365 Finance

Microsoft Dynamics Business Central

Microsoft Dynamics On-Premise

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

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

Set tenant config

Update tenant config

Create linked flows

Returns the flows that are currently linked for a specific tenant

Retrieve linked flows

Returns all flows in an environment and their connectors

Retrieve supported 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

Kill job

Returns a list of job details for a specified tenant. Note that this endpoint does not return raw data fetched in jobs.

Fetch jobs

Trigger download

Fetch job zip

Create jobs schedule

hotglue API

V1 - One Way Flows

V2 - Two Way Flows

Retrieve jobs schedule

Authorizations

Path Parameters

Response