hotglue Docs home page

Dashboard
Status
Dashboard

Linked targets

Link a target

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 targets

Link a target

Link one of your tenants to a target

POST

{env_id}

{flow_id}

{tenant}

linkedTargets

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

target

object

target

Required

object

The target & settings info you wish to link

target

string

target

Required

string

The name of the connector you want to link

symlink

object

symlink

object

Symlink allows you to share credentials with an existing connection in 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

config

object

config

object

This JSON object holds credentials and flags to create a connection.

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

target

object

required

The target & settings info you wish to link

target.target

string

required

The name of the connector you want to link

target.symlink

object

Symlink allows you to share credentials with an existing connection in another flow

target.symlink.entity

string

The name of the connector that is already linked

target.symlink.id

string

The previously linked flow_id containing a user's credentials

target.config

object

This JSON object holds credentials and flags to create a connection.

Response

200 - application/json

The response is of type object.

Delete source state Unlink a target

twitter github linkedin