Run a V2 Job
curl --request POST \
--url https://api.hotglue.com/v2/{env_id}/{flow_id}/{tenant}/jobs \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"connector_id": "<string>",
"job_name": "<string>",
"external_job_id": "<string>",
"override_start_date": "2023-12-25",
"override_end_date": "2023-12-25",
"reset_source_state": true,
"override_selected_tables": {},
"override_source_config": {},
"override_target_config": {},
"override_connector_config": {},
"override_field_map": {},
"environment_variables": {},
"state": {},
"streaming_job": true,
"ignore_parallel_jobs": true,
"queue_if_active_job": true
}
'import requests
url = "https://api.hotglue.com/v2/{env_id}/{flow_id}/{tenant}/jobs"
payload = {
"connector_id": "<string>",
"job_name": "<string>",
"external_job_id": "<string>",
"override_start_date": "2023-12-25",
"override_end_date": "2023-12-25",
"reset_source_state": True,
"override_selected_tables": {},
"override_source_config": {},
"override_target_config": {},
"override_connector_config": {},
"override_field_map": {},
"environment_variables": {},
"state": {},
"streaming_job": True,
"ignore_parallel_jobs": True,
"queue_if_active_job": True
}
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({
connector_id: '<string>',
job_name: '<string>',
external_job_id: '<string>',
override_start_date: '2023-12-25',
override_end_date: '2023-12-25',
reset_source_state: true,
override_selected_tables: {},
override_source_config: {},
override_target_config: {},
override_connector_config: {},
override_field_map: {},
environment_variables: {},
state: {},
streaming_job: true,
ignore_parallel_jobs: true,
queue_if_active_job: true
})
};
fetch('https://api.hotglue.com/v2/{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/v2/{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([
'connector_id' => '<string>',
'job_name' => '<string>',
'external_job_id' => '<string>',
'override_start_date' => '2023-12-25',
'override_end_date' => '2023-12-25',
'reset_source_state' => true,
'override_selected_tables' => [
],
'override_source_config' => [
],
'override_target_config' => [
],
'override_connector_config' => [
],
'override_field_map' => [
],
'environment_variables' => [
],
'state' => [
],
'streaming_job' => true,
'ignore_parallel_jobs' => true,
'queue_if_active_job' => true
]),
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/v2/{env_id}/{flow_id}/{tenant}/jobs"
payload := strings.NewReader("{\n \"connector_id\": \"<string>\",\n \"job_name\": \"<string>\",\n \"external_job_id\": \"<string>\",\n \"override_start_date\": \"2023-12-25\",\n \"override_end_date\": \"2023-12-25\",\n \"reset_source_state\": true,\n \"override_selected_tables\": {},\n \"override_source_config\": {},\n \"override_target_config\": {},\n \"override_connector_config\": {},\n \"override_field_map\": {},\n \"environment_variables\": {},\n \"state\": {},\n \"streaming_job\": true,\n \"ignore_parallel_jobs\": true,\n \"queue_if_active_job\": true\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/v2/{env_id}/{flow_id}/{tenant}/jobs")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"connector_id\": \"<string>\",\n \"job_name\": \"<string>\",\n \"external_job_id\": \"<string>\",\n \"override_start_date\": \"2023-12-25\",\n \"override_end_date\": \"2023-12-25\",\n \"reset_source_state\": true,\n \"override_selected_tables\": {},\n \"override_source_config\": {},\n \"override_target_config\": {},\n \"override_connector_config\": {},\n \"override_field_map\": {},\n \"environment_variables\": {},\n \"state\": {},\n \"streaming_job\": true,\n \"ignore_parallel_jobs\": true,\n \"queue_if_active_job\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hotglue.com/v2/{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 \"connector_id\": \"<string>\",\n \"job_name\": \"<string>\",\n \"external_job_id\": \"<string>\",\n \"override_start_date\": \"2023-12-25\",\n \"override_end_date\": \"2023-12-25\",\n \"reset_source_state\": true,\n \"override_selected_tables\": {},\n \"override_source_config\": {},\n \"override_target_config\": {},\n \"override_connector_config\": {},\n \"override_field_map\": {},\n \"environment_variables\": {},\n \"state\": {},\n \"streaming_job\": true,\n \"ignore_parallel_jobs\": true,\n \"queue_if_active_job\": true\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"
}{}V2 Flows
Run a V2 Job
Kicks off a job for a given tenant. Can be used to write data in target flows by passing a payload in the state object. When queue_if_active_job is set to true in the request body, hotglue queues the job if another job is already running for the same tenant or flow.
POST
/
v2
/
{env_id}
/
{flow_id}
/
{tenant}
/
jobs
Run a V2 Job
curl --request POST \
--url https://api.hotglue.com/v2/{env_id}/{flow_id}/{tenant}/jobs \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"connector_id": "<string>",
"job_name": "<string>",
"external_job_id": "<string>",
"override_start_date": "2023-12-25",
"override_end_date": "2023-12-25",
"reset_source_state": true,
"override_selected_tables": {},
"override_source_config": {},
"override_target_config": {},
"override_connector_config": {},
"override_field_map": {},
"environment_variables": {},
"state": {},
"streaming_job": true,
"ignore_parallel_jobs": true,
"queue_if_active_job": true
}
'import requests
url = "https://api.hotglue.com/v2/{env_id}/{flow_id}/{tenant}/jobs"
payload = {
"connector_id": "<string>",
"job_name": "<string>",
"external_job_id": "<string>",
"override_start_date": "2023-12-25",
"override_end_date": "2023-12-25",
"reset_source_state": True,
"override_selected_tables": {},
"override_source_config": {},
"override_target_config": {},
"override_connector_config": {},
"override_field_map": {},
"environment_variables": {},
"state": {},
"streaming_job": True,
"ignore_parallel_jobs": True,
"queue_if_active_job": True
}
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({
connector_id: '<string>',
job_name: '<string>',
external_job_id: '<string>',
override_start_date: '2023-12-25',
override_end_date: '2023-12-25',
reset_source_state: true,
override_selected_tables: {},
override_source_config: {},
override_target_config: {},
override_connector_config: {},
override_field_map: {},
environment_variables: {},
state: {},
streaming_job: true,
ignore_parallel_jobs: true,
queue_if_active_job: true
})
};
fetch('https://api.hotglue.com/v2/{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/v2/{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([
'connector_id' => '<string>',
'job_name' => '<string>',
'external_job_id' => '<string>',
'override_start_date' => '2023-12-25',
'override_end_date' => '2023-12-25',
'reset_source_state' => true,
'override_selected_tables' => [
],
'override_source_config' => [
],
'override_target_config' => [
],
'override_connector_config' => [
],
'override_field_map' => [
],
'environment_variables' => [
],
'state' => [
],
'streaming_job' => true,
'ignore_parallel_jobs' => true,
'queue_if_active_job' => true
]),
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/v2/{env_id}/{flow_id}/{tenant}/jobs"
payload := strings.NewReader("{\n \"connector_id\": \"<string>\",\n \"job_name\": \"<string>\",\n \"external_job_id\": \"<string>\",\n \"override_start_date\": \"2023-12-25\",\n \"override_end_date\": \"2023-12-25\",\n \"reset_source_state\": true,\n \"override_selected_tables\": {},\n \"override_source_config\": {},\n \"override_target_config\": {},\n \"override_connector_config\": {},\n \"override_field_map\": {},\n \"environment_variables\": {},\n \"state\": {},\n \"streaming_job\": true,\n \"ignore_parallel_jobs\": true,\n \"queue_if_active_job\": true\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/v2/{env_id}/{flow_id}/{tenant}/jobs")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"connector_id\": \"<string>\",\n \"job_name\": \"<string>\",\n \"external_job_id\": \"<string>\",\n \"override_start_date\": \"2023-12-25\",\n \"override_end_date\": \"2023-12-25\",\n \"reset_source_state\": true,\n \"override_selected_tables\": {},\n \"override_source_config\": {},\n \"override_target_config\": {},\n \"override_connector_config\": {},\n \"override_field_map\": {},\n \"environment_variables\": {},\n \"state\": {},\n \"streaming_job\": true,\n \"ignore_parallel_jobs\": true,\n \"queue_if_active_job\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hotglue.com/v2/{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 \"connector_id\": \"<string>\",\n \"job_name\": \"<string>\",\n \"external_job_id\": \"<string>\",\n \"override_start_date\": \"2023-12-25\",\n \"override_end_date\": \"2023-12-25\",\n \"reset_source_state\": true,\n \"override_selected_tables\": {},\n \"override_source_config\": {},\n \"override_target_config\": {},\n \"override_connector_config\": {},\n \"override_field_map\": {},\n \"environment_variables\": {},\n \"state\": {},\n \"streaming_job\": true,\n \"ignore_parallel_jobs\": true,\n \"queue_if_active_job\": true\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
Path Parameters
ID of environment
ID of flow
ID of tenant
Body
application/json
The ID of the connector to run a job for. Note that in V2 flows, you do not pass a tap or target
The schedule expression to sync on
Available options:
read, write Name for job. If not provided, name is autogenerated
External job ID for job. This is used to link the job to an external system.
Date to start syncing data from (e.g. 2022-08-08T00:00:00.000Z)
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
Show child attributes
Date to sync data until. Only supported on some connectors. (e.g. 2022-08-10T00:00:00.000Z)
Runs the job as a "full_sync" by clearing the state on the linkedSource
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 the source connector configuration for this job only. Does not affect the saved configuration.
Override the target connector configuration for this job only. Does not affect the saved configuration.
Override the bidirectional connector-level configuration for this job only.
Define a temporary field map to be used in the job, different from the configured field map.
Override environment variables for the job execution.
Optional extra context to be used by the job. Often used for write jobs. Note that this is different from the source state.
If true, the job will run in streaming mode and skip the ETL step. This feature is in beta.
If true, the job will ignore restrictions on parallel job execution for this connector.
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.
Response
200
Example:
"37g_DK"
Example:
"mydomain.hotglue.xyz"
Example:
"l8odS2mce"
Example:
"l8odS2mce-chargebee-20220119-153011"
Example:
"asdijsdijasd"
Example:
12598713
Example:
12598713
Example:
"12598713/flows/l8odS2mce/jobs/2022/01/4/19/15/37g_DK"
Example:
"2022-01-19T15:30:11.731333+00:00"
Example:
"chargebee"
Available options:
JOB_CREATED, DISCOVER_STARTED, DISCOVER_FAILED, SYNC_STARTED, SYNC_FAILED, SYNC_SUCCESS, ETL_STARTED, ETL_FAILED, ETL_SUCCESS, EXPORT_STARTED, EXPORT_FAILED, JOB_COMPLETED Example:
"JOB_CREATED"
Example:
true
Example:
"..."
Example:
"2022-01-19T15:35:13.982380+00:00"
Example:
0