Skip to main content

​
Connector Details

NameValue
PlatformAPI
Auth TypeAPI Keys
DirectionBidirectional
Target Repohttps://github.com/hotgluexyz/target-api
Tap Metrics

Usage:

Target Metrics

Usage:

​
Overview

The API connector lets you move data between your product and HTTP endpoints via hotglue. You can use it as a target to send records to an API, or as a source to push JSON data into a hotglue write job.

​
Writing data to an API endpoint

As a target, the API connector sends data to a configured endpoint as JSON POST requests. Configure the endpoint URL, authentication, and other settings in your flow, and hotglue will deliver records from write jobs to that destination. The API connector’s write behavior is powered by target-api, a hotglue maintained Singer target. To see all supported settings and capabilities, view the repository’s README.

​
Pushing data via the API source

As a source, the API connector does not pull data from arbitrary external APIs. Instead, your product pushes data into hotglue, which writes it to the configured target. There are two ways to do this:

​
POST /jobs endpoint

Send records in the state field of a POST /jobs request. hotglue starts the write job when you call the endpoint, but the records are exported inside the job—not in the API response itself. You won’t receive per-record success or failure in the response; check results in the hotglue dashboard or via the jobs API after the job completes. Use this approach when you need to send many records at once or want universal support across all targets. See Trigger a write job via API for request examples and v1/v2 flow details.

​
Real-time write

Send a record to the real-time write endpoint. hotglue writes the record synchronously and returns success or failure directly in the API response. Use this approach when you need immediate feedback on a single record write—for example, confirming a contact was created in a tenant’s CRM before showing success in your product. Real-time write is supported for many targets, but not all, which differs compared to the POST /jobs endpoint approach. See the real-time write API reference for request format and response details.

​
Reading from external APIs

The API source does not support fetching data from arbitrary third-party APIs. It is designed for pushing data from your product into hotglue, not for extracting data from other systems. If you need to read data from a custom HTTP endpoint, build a custom Singer tap to extract the data. See Creating Singer taps for instructions on scaffolding a tap with the hotglue cookiecutter template and HotglueSingerSDK.

​
Target Changelog