hotglue Docs home page

Dashboard
Status
Dashboard

Linked sources

Link a source

Documentation

API Reference

Unified API Schemas

hotglue API

Overview
Secure Requests
Manage Tenants
Flows
Jobs
Schedule jobs

V1 - One Way Flows

Introduction
POST
Run a V1 job
Source metadata
Linked sources
Linked sources state
Linked targets

V2 - Two Way Flows

Introduction
POST
Run a V2 Job
Connector metadata
Linked connectors

BETA - Real-time Write

POST
Send unified data to a connector

Linked sources

Link a source

Create a new connection for a tenant by passing a config object, along with an optional schedule or field_map

POST

{env_id}

{flow_id}

{tenant}

linkedSources

x-api-key

string

x-api-key

Required

string

env_id

string

env_id

Required

string

ID of environment

flow_id

string

flow_id

Required

string

ID of flow

tenant

string

tenant

Required

string

ID of tenant

object

source

object

source

Required

object

The source & settings info you wish to link

tap

string

tap

Required

string

Name of tap

config

object

config

object

JSON object containing settings for the source

symlink

object

symlink

object

Symlink allows you to share credentials with a connection from another flow

entity

string

entity

string

The name of the connector that is already linked

string

The previously linked flow_id containing a user's credentials

schedule

object

schedule

object

The schedule expression to sync on

schedule_expression

string

schedule_expression

string

A CRON expression defining how often to run jobs for the tenant

state

enum<string>

state

enum<string>

Whether the schedule should be enabled or disabled

field_map

object

field_map

object

The field map to use (if not provided, will use default)

Authorizations

x-api-key

string

headerrequired

Path Parameters

env_id

string

required

ID of environment

flow_id

string

required

ID of flow

tenant

string

required

ID of tenant

Body

application/json

source

object

required

The source & settings info you wish to link

source.tap

string

required

Name of tap

source.config

object

JSON object containing settings for the source

source.symlink

object

Symlink allows you to share credentials with a connection from another flow

source.symlink.entity

string

The name of the connector that is already linked

source.symlink.id

string

The previously linked flow_id containing a user's credentials

schedule

object

The schedule expression to sync on

schedule.schedule_expression

string

A CRON expression defining how often to run jobs for the tenant

schedule.state

enum<string>

Whether the schedule should be enabled or disabled

Available options:

ENABLED,

DISABLED

field_map

object

The field map to use (if not provided, will use default)

Response

200 - application/json

The response is of type object.

Available sources Unlink a source

twitter github linkedin