Run a V1 job

curl --request POST \
  --url https://api.hotglue.com/{env_id}/{flow_id}/{tenant}/jobs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "state": {},
  "tap": "<string>",
  "job_name": "<string>",
  "external_job_id": "<string>",
  "override_start_date": "2023-11-07T05:31:56Z",
  "reset_source_state": true,
  "streaming_job": true,
  "override_selected_tables": {},
  "override_field_map": {},
  "override_end_date": "2023-11-07T05:31:56Z",
  "override_source_config": {},
  "override_target_config": {},
  "ignore_parallel_jobs": true,
  "queue_if_active_job": true,
  "environment_variables": {}
}
'

import requests

url = "https://api.hotglue.com/{env_id}/{flow_id}/{tenant}/jobs"

payload = {
    "state": {},
    "tap": "<string>",
    "job_name": "<string>",
    "external_job_id": "<string>",
    "override_start_date": "2023-11-07T05:31:56Z",
    "reset_source_state": True,
    "streaming_job": True,
    "override_selected_tables": {},
    "override_field_map": {},
    "override_end_date": "2023-11-07T05:31:56Z",
    "override_source_config": {},
    "override_target_config": {},
    "ignore_parallel_jobs": True,
    "queue_if_active_job": True,
    "environment_variables": {}
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    state: {},
    tap: '<string>',
    job_name: '<string>',
    external_job_id: '<string>',
    override_start_date: '2023-11-07T05:31:56Z',
    reset_source_state: true,
    streaming_job: true,
    override_selected_tables: {},
    override_field_map: {},
    override_end_date: '2023-11-07T05:31:56Z',
    override_source_config: {},
    override_target_config: {},
    ignore_parallel_jobs: true,
    queue_if_active_job: true,
    environment_variables: {}
  })
};

fetch('https://api.hotglue.com/{env_id}/{flow_id}/{tenant}/jobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hotglue.com/{env_id}/{flow_id}/{tenant}/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'state' => [
        
    ],
    'tap' => '<string>',
    'job_name' => '<string>',
    'external_job_id' => '<string>',
    'override_start_date' => '2023-11-07T05:31:56Z',
    'reset_source_state' => true,
    'streaming_job' => true,
    'override_selected_tables' => [
        
    ],
    'override_field_map' => [
        
    ],
    'override_end_date' => '2023-11-07T05:31:56Z',
    'override_source_config' => [
        
    ],
    'override_target_config' => [
        
    ],
    'ignore_parallel_jobs' => true,
    'queue_if_active_job' => true,
    'environment_variables' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hotglue.com/{env_id}/{flow_id}/{tenant}/jobs"

	payload := strings.NewReader("{\n  \"state\": {},\n  \"tap\": \"<string>\",\n  \"job_name\": \"<string>\",\n  \"external_job_id\": \"<string>\",\n  \"override_start_date\": \"2023-11-07T05:31:56Z\",\n  \"reset_source_state\": true,\n  \"streaming_job\": true,\n  \"override_selected_tables\": {},\n  \"override_field_map\": {},\n  \"override_end_date\": \"2023-11-07T05:31:56Z\",\n  \"override_source_config\": {},\n  \"override_target_config\": {},\n  \"ignore_parallel_jobs\": true,\n  \"queue_if_active_job\": true,\n  \"environment_variables\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hotglue.com/{env_id}/{flow_id}/{tenant}/jobs")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"state\": {},\n  \"tap\": \"<string>\",\n  \"job_name\": \"<string>\",\n  \"external_job_id\": \"<string>\",\n  \"override_start_date\": \"2023-11-07T05:31:56Z\",\n  \"reset_source_state\": true,\n  \"streaming_job\": true,\n  \"override_selected_tables\": {},\n  \"override_field_map\": {},\n  \"override_end_date\": \"2023-11-07T05:31:56Z\",\n  \"override_source_config\": {},\n  \"override_target_config\": {},\n  \"ignore_parallel_jobs\": true,\n  \"queue_if_active_job\": true,\n  \"environment_variables\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hotglue.com/{env_id}/{flow_id}/{tenant}/jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"state\": {},\n  \"tap\": \"<string>\",\n  \"job_name\": \"<string>\",\n  \"external_job_id\": \"<string>\",\n  \"override_start_date\": \"2023-11-07T05:31:56Z\",\n  \"reset_source_state\": true,\n  \"streaming_job\": true,\n  \"override_selected_tables\": {},\n  \"override_field_map\": {},\n  \"override_end_date\": \"2023-11-07T05:31:56Z\",\n  \"override_source_config\": {},\n  \"override_target_config\": {},\n  \"ignore_parallel_jobs\": true,\n  \"queue_if_active_job\": true,\n  \"environment_variables\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "job_id": "37g_DK",
  "env_id": "mydomain.hotglue.xyz",
  "flow_id": "l8odS2mce",
  "job_name": "l8odS2mce-chargebee-20220119-153011",
  "external_job_id": "asdijsdijasd",
  "tenant": "12598713",
  "started_by": "12598713",
  "s3_root": "12598713/flows/l8odS2mce/jobs/2022/01/4/19/15/37g_DK",
  "start_time": "2022-01-19T15:30:11.731333+00:00",
  "state": {},
  "tap": "chargebee",
  "status": "JOB_CREATED",
  "scheduled_job": true,
  "message": "...",
  "last_updated": "2022-01-19T15:35:13.982380+00:00",
  "processed_rows": 0
}

{
  "message": "Job has been queued. It will run when available",
  "reason": "There is a job currently running"
}

{}

POST

{env_id}

{flow_id}

{tenant}

jobs

Run a V1 job

curl --request POST \
  --url https://api.hotglue.com/{env_id}/{flow_id}/{tenant}/jobs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "state": {},
  "tap": "<string>",
  "job_name": "<string>",
  "external_job_id": "<string>",
  "override_start_date": "2023-11-07T05:31:56Z",
  "reset_source_state": true,
  "streaming_job": true,
  "override_selected_tables": {},
  "override_field_map": {},
  "override_end_date": "2023-11-07T05:31:56Z",
  "override_source_config": {},
  "override_target_config": {},
  "ignore_parallel_jobs": true,
  "queue_if_active_job": true,
  "environment_variables": {}
}
'

import requests

url = "https://api.hotglue.com/{env_id}/{flow_id}/{tenant}/jobs"

payload = {
    "state": {},
    "tap": "<string>",
    "job_name": "<string>",
    "external_job_id": "<string>",
    "override_start_date": "2023-11-07T05:31:56Z",
    "reset_source_state": True,
    "streaming_job": True,
    "override_selected_tables": {},
    "override_field_map": {},
    "override_end_date": "2023-11-07T05:31:56Z",
    "override_source_config": {},
    "override_target_config": {},
    "ignore_parallel_jobs": True,
    "queue_if_active_job": True,
    "environment_variables": {}
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    state: {},
    tap: '<string>',
    job_name: '<string>',
    external_job_id: '<string>',
    override_start_date: '2023-11-07T05:31:56Z',
    reset_source_state: true,
    streaming_job: true,
    override_selected_tables: {},
    override_field_map: {},
    override_end_date: '2023-11-07T05:31:56Z',
    override_source_config: {},
    override_target_config: {},
    ignore_parallel_jobs: true,
    queue_if_active_job: true,
    environment_variables: {}
  })
};

fetch('https://api.hotglue.com/{env_id}/{flow_id}/{tenant}/jobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hotglue.com/{env_id}/{flow_id}/{tenant}/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'state' => [
        
    ],
    'tap' => '<string>',
    'job_name' => '<string>',
    'external_job_id' => '<string>',
    'override_start_date' => '2023-11-07T05:31:56Z',
    'reset_source_state' => true,
    'streaming_job' => true,
    'override_selected_tables' => [
        
    ],
    'override_field_map' => [
        
    ],
    'override_end_date' => '2023-11-07T05:31:56Z',
    'override_source_config' => [
        
    ],
    'override_target_config' => [
        
    ],
    'ignore_parallel_jobs' => true,
    'queue_if_active_job' => true,
    'environment_variables' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hotglue.com/{env_id}/{flow_id}/{tenant}/jobs"

	payload := strings.NewReader("{\n  \"state\": {},\n  \"tap\": \"<string>\",\n  \"job_name\": \"<string>\",\n  \"external_job_id\": \"<string>\",\n  \"override_start_date\": \"2023-11-07T05:31:56Z\",\n  \"reset_source_state\": true,\n  \"streaming_job\": true,\n  \"override_selected_tables\": {},\n  \"override_field_map\": {},\n  \"override_end_date\": \"2023-11-07T05:31:56Z\",\n  \"override_source_config\": {},\n  \"override_target_config\": {},\n  \"ignore_parallel_jobs\": true,\n  \"queue_if_active_job\": true,\n  \"environment_variables\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hotglue.com/{env_id}/{flow_id}/{tenant}/jobs")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"state\": {},\n  \"tap\": \"<string>\",\n  \"job_name\": \"<string>\",\n  \"external_job_id\": \"<string>\",\n  \"override_start_date\": \"2023-11-07T05:31:56Z\",\n  \"reset_source_state\": true,\n  \"streaming_job\": true,\n  \"override_selected_tables\": {},\n  \"override_field_map\": {},\n  \"override_end_date\": \"2023-11-07T05:31:56Z\",\n  \"override_source_config\": {},\n  \"override_target_config\": {},\n  \"ignore_parallel_jobs\": true,\n  \"queue_if_active_job\": true,\n  \"environment_variables\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hotglue.com/{env_id}/{flow_id}/{tenant}/jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"state\": {},\n  \"tap\": \"<string>\",\n  \"job_name\": \"<string>\",\n  \"external_job_id\": \"<string>\",\n  \"override_start_date\": \"2023-11-07T05:31:56Z\",\n  \"reset_source_state\": true,\n  \"streaming_job\": true,\n  \"override_selected_tables\": {},\n  \"override_field_map\": {},\n  \"override_end_date\": \"2023-11-07T05:31:56Z\",\n  \"override_source_config\": {},\n  \"override_target_config\": {},\n  \"ignore_parallel_jobs\": true,\n  \"queue_if_active_job\": true,\n  \"environment_variables\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "job_id": "37g_DK",
  "env_id": "mydomain.hotglue.xyz",
  "flow_id": "l8odS2mce",
  "job_name": "l8odS2mce-chargebee-20220119-153011",
  "external_job_id": "asdijsdijasd",
  "tenant": "12598713",
  "started_by": "12598713",
  "s3_root": "12598713/flows/l8odS2mce/jobs/2022/01/4/19/15/37g_DK",
  "start_time": "2022-01-19T15:30:11.731333+00:00",
  "state": {},
  "tap": "chargebee",
  "status": "JOB_CREATED",
  "scheduled_job": true,
  "message": "...",
  "last_updated": "2022-01-19T15:35:13.982380+00:00",
  "processed_rows": 0
}

{
  "message": "Job has been queued. It will run when available",
  "reason": "There is a job currently running"
}

{}

Authorizations

x-api-key

string

header

required

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

state

object

Pass extra context to be used in the job. Often used with the unified schema for write jobs. Note that this is different from the source state.

tap

string

The source of the job. For write jobs, this is usually "api."

job_name

string

Name for job. If not provided, name is autogenerated

external_job_id

string

External job ID for job. This is used to link the job to an external system.

override_start_date

string<date-time>

Date to start syncing data from (e.g. 2022-08-08T00:00:00.000Z)

override_selected_filters

object

Override the selected filters for this job only. Uses the same format as the selected filters configuration and does not affect the saved selection.

Show child attributes

reset_source_state

boolean

Runs the job as a "full_sync" by clearing the state on the linkedSource

streaming_job

boolean

If true, the job will run in streaming mode and skip the ETL step. This feature is in beta.

override_selected_tables

object

For use with the unified schema. Define a temporary selection of unified schema objects to override the default selection. Does not affect your selection for future jobs. E.G. {"Vendors":true}

override_field_map

object

Define a temporary field map to be used in the job, different from the configured field map.

override_end_date

string<date-time>

Date to sync data until (e.g. 2022-08-08T00:00:00.000Z). Note that end_date is only supported for certain connectors.

override_source_config

object

Override the source connector configuration for this job only. Does not affect the saved configuration.

override_target_config

object

Override the target connector configuration for this job only. Does not affect the saved configuration.

ignore_parallel_jobs

boolean

If true, the job will ignore restrictions on parallel job execution for this connector.

queue_if_active_job

boolean

If set to true, queues the job when another job is already running for the same tenant or flow. If omitted or set to false, the API returns an error when an active job blocks creation.

environment_variables

object

Override environment variables for the job execution. Does not affect saved configuration.

Response

200

job_id

string

Example:

"37g_DK"

env_id

string

Example:

"mydomain.hotglue.xyz"

flow_id

string

Example:

"l8odS2mce"

job_name

string

Example:

"l8odS2mce-chargebee-20220119-153011"

external_job_id

string

Example:

"asdijsdijasd"

tenant

string

Example:

12598713

started_by

string

Example:

12598713

s3_root

string

Example:

"12598713/flows/l8odS2mce/jobs/2022/01/4/19/15/37g_DK"

start_time

string

Example:

"2022-01-19T15:30:11.731333+00:00"

state

object

tap

string

Example:

"chargebee"

status

enum<string>

Available options:

JOB_CREATED,

PROVISION_FAILED,

DISCOVER_STARTED,

DISCOVER_SUCCESS,

DISCOVER_FAILED,

SYNC_STARTED,

SYNC_FAILED,

SYNC_SUCCESS,

ETL_STARTED,

ETL_FAILED,

ETL_SUCCESS,

EXPORT_STARTED,

EXPORT_FAILED,

JOB_COMPLETED

Example:

"JOB_CREATED"

scheduled_job

boolean

default:true

Example:

true

message

string

Example:

"..."

last_updated

string

Example:

"2022-01-19T15:35:13.982380+00:00"

processed_rows

integer

default:0

Example:

0

hotglue API

V1 flows (legacy)

V2 Flows

Connectors

MCP

Run a V1 job

Authorizations

Path Parameters

Body

Response