hotglue Docs home page

Dashboard
Status
Dashboard

Linked connectors

Link a connector

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 connectors

Link a connector

Create a new connection for your tenant, along with an optional schedule and field map, without using the embedded widget.

POST

{env_id}

{flow_id}

{tenant}

linkedConnectors

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

connector

object

connector

Required

object

Connector

string

Required

string

The ID of your connector. You can fetch this from your available or supported connectors

config

object

config

object

The config object holds key-value pairs with credentials and flags for your connector. These are shared for imports and exports.

schedule

object

schedule

object

The schedule expression to sync on

schedule_expression

string

schedule_expression

string

CRON expression to set or update the schedule

state

enum<string>

state

enum<string>

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

connector

object

required

Connector

connector.id

string

required

The ID of your connector. You can fetch this from your available or supported connectors

connector.config

object

The config object holds key-value pairs with credentials and flags for your connector. These are shared for imports and exports.

schedule

object

The schedule expression to sync on

schedule.schedule_expression

string

CRON expression to set or update the schedule

schedule.state

enum<string>

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.

Retrieve linked connector Update linked connectors

twitter github linkedin