Start a job

Widget

The easiest way to start a job is via the embeddable widget. You can do this via the widget API or by enabling the option for users to run jobs themselves:

Allow users to run jobs

Now, users can run jobs directly from the widget:

Run job option in widget

API

You can also start, poll, and manage jobs via the API.

post
Create a job

https://client-api.hotglue.xyz/{env_id}/{flow_id}/{tenant}/jobs
This endpoint creates a new job and queues it for execution.
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
state
optional
object
Any extra state information to pass
tap
optional
string
Tap to sync
job_name
optional
string
Name for job. If not provided, name is autogenerated
Response
200: OK
Job queued.
{
"job_id": "kIhYt"
}

Manually

To manually trigger a job via the hotglue admin panel, head to the flow (ie. Sales), and select the jobs tab. From here, select New Job in the top right

hotglue flow – jobs dashboard

You will be presented with the following screen asking you to select the source to sync from and to set a name for the job.

hotglue admin panel – create a job

By default, the Sales flow has the HubSpot and Salesforce source available. For this example, we'll select the Salesforce source and name the job demo job

Check off "Reset source state prior to job" if you want to test pulling data you've already synced

hotglue admin panel – start a job

After selecting Create Job, the job will be queued for execution, and you can monitor the jobs progress, in the dashboard:

hotglue – job dashboard

If you click on the job, you can monitor the logs in real time, and refresh to continue monitoring the state. Learn more about the job lifecycle in the docs.

That's it – you've successfully tested your first integration! To learn how to test transform scripts in Jupyter, go to the Transformation section.