Linked Sources

get
Get linked sources

https://client-api.hotglue.xyz/{env_id}/{flow_id}/{tenant}/linkedSources
This endpoint returns the source currently linked for this flow and tenant
Request
Response
Request
Path Parameters
env_id
required
string
ID of environment
flow_id
required
string
ID of flow
tenant
required
string
ID of tenant
Headers
x-api-key
required
string
API key
Query Parameters
token
optional
string
JWT token generated with your private signing key. Required if config is requested
config
optional
boolean
Request the underlying config for the linked source
catalog
optional
boolean
Request the catalog of available fields/data to be returned in the payload
Response
200: OK
Array of all linked sources
[{
"tap": "asana",
"domain": "asana.com",
"label": "Asana",
"tap_url": "https://app.asana.com/-/oauth_authorize?response_type=code&client_id=*********",
"auth_url": "https://app.asana.com/-/oauth_token",
"icon": "https://s3.amazonaws.com/cdn.hotglue.xyz/images/logos/asana.svg",
"type": "oauth",
"client_id": "**********",
"fieldMap": {
"tasks": {
"name": "tasks",
"selected": ["gid", "modified_at", "resource_type", "name", "approval_status", "assignee_status", "completed", "completed_at", "completed_by", "created_at", "dependencies", "dependents", "due_at", "due_on", "external", "hearted", "hearts", "html_notes", "is_rendered_as_seperator", "liked", "likes", "memberships", "notes", "num_hearts", "num_likes", "num_subtasks", "resource_subtype", "start_on", "assignee", "custom_fields", "followers", "parent", "permalink_url", "projects", "tags", "workspace"]
}
}
}]

post
Add linked source

https://client-api.hotglue.xyz/{env_id}/{flow_id}/{tenant}/linkedSources
This endpoint adds a linked source directly via the API
Request
Response
Request
Path Parameters
env_id
required
string
ID of environment
flow_id
required
string
ID of flow
tenant
required
string
ID of tenant
Headers
x-api-key
required
string
API key
Body Parameters
source
required
object
The source & settings info you wish to link
schedule
optional
object
The schedule expression to sync on
field_map
optional
string
The field map to use (if not provided, will use default)
Response
200: OK
Empty response

delete
Remove linked source

https://client-api.hotglue.xyz/{env_id}/{flow_id}/{tenant}/linkedSources
This endpoint unlinks the source currently linked for this flow and tenant
Request
Response
Request
Path Parameters
env_id
required
string
ID of environment
flow_id
required
string
ID of flow
tenant
required
string
ID of tenant
Headers
x-api-key
required
string
API key
Response
200: OK
{
"Code": "Success"
}

get
Discover catalog

https://client-api.hotglue.xyz/{env_id}/{flow_id}/{tenant}/linkedSources/discover
This endpoint starts an asynchronous task to refetch a catalog of all available data in the specified tap/tenant.
Request
Response
Request
Path Parameters
env_id
required
string
ID of environment
flow_id
required
string
ID of flow
tenant
required
string
ID of tenant
Headers
x-api-key
required
string
API key
Query Parameters
tap_name
required
string
Name of tap to discover
Response
200: OK
No return value, just 200 status

get
Poll discover

https://client-api.hotglue.xyz/{env_id}/{flow_id}/{tenant}/linkedSources/discover/poll
This endpoint polls any running discover task and returns the current status
Request
Response
Request
Path Parameters
env_id
required
string
ID of environment
flow_id
required
string
ID of flow
tenant
required
string
ID of tenant
Headers
x-api-key
required
string
API key
Query Parameters
tap_name
required
string
Name of tap to query
Response
200: OK
Status of running task, if any else status will be null
{
"status": "RUNNING"
}

patch
Update field map

https://client-api.hotglue.xyz/{env_id}/{flow_id}/{tenant}/linkedSources
This endpoint updates the field map for a source
Request
Response
Request
Path Parameters
env_id
required
string
ID of environment
flow_id
required
string
ID of flow
tenant
required
string
ID of tenant
Headers
x-api-key
required
string
API key
Body Parameters
field_map
required
object
JSON object representing all fields to pull
tap
required
string
Name of tap to update
Response
200: OK
Returns empty response, 200 status code

delete
Reset source state

https://client-api.hotglue.xyz/{env_id}/{flow_id}/{tenant}/linkedSources/state
This endpoint resets the current state for a linked source.
Request
Response
Request
Path Parameters
env_id
required
string
ID of environment
flow_id
required
string
ID of flow
tenant
required
string
ID of tenant
Headers
x-api-key
required
string
API key
Body Parameters
tap_name
required
string
Name of tap to update
Response
200: OK
Returns empty response, 200 status code