Toggl

Toggl is a cloud-based time-tracking platform.

Toggl integration replicates data using the Toggl API v8.

See the Schema section for a list of objects available for replication.

A high-level look at this connector, including useful links, and supported features.

Feature/Capability	Support details
Supported Qlik Talend Data Integration projects	Replication projects only. Data pipeline projects are not supported.
Target update methods	Replication tasks: Apply changes Store changes Landing data in a data lake tasks: Change data capture (CDC)
Managing metadata	Manual metadata generation is not required.
Schema evolution	Only the Change column data type operation is supported.
Replication of LOB columns (NCLOB, CLOB, and BLOB)	Not supported.
Scheduled CDC	Required. This is how the target is kept up-to-date with changes to the source. For replication tasks, see Scheduling tasks For lake landing tasks, see Scheduling CDC for lake landing tasks
Notifications	Partially supported Setting notifications for changes in operation
Monitoring	CDC-only, as full load is not relevant for this connector. Monitoring an individual data task
Automatic denesting of JSON column payloads	Not supported. JSON column payloads in source datasets are not denested automatically on the target.

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Make sure that the account you use has read access to the tables you want to fetch.

To set up your Toggl account, you need:

Your Toggl API token is specific to your user. When replicating data, Qlik Talend Cloud is only able to access the same data as your user in Toggl.
To replicate time entry data from multiple workspaces, you must be an Admin in the workspace from which you want to replicate data. Verify that you have this permission in Toggl before proceeding.

To retrieve your API token:

Log into your Toggl account.
Click the Workspace menu in the lower left corner.
Click Profile settings.
Locate the API token field.
Copy the API token.

Creating the connection

For more information, see Connecting to SaaS applications.

Fill in the required connection properties.
Provide a name for the connection in Connection name.
Select Open connection metadata to define metadata for the connection when it has been created.
Click Create.

Connection settings
Setting	Description
Data gateway	Select a Data Movement gateway if required by your use case. Information note This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None. For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement.
Start Date	Enter the date, in the format `MM/DD/YYYY`, from which the data must be replicated from your source to your target.
API Token	API token.
Trailing Days	Enter the number of days to be used as an attribution window when replicating time entry data. This is only applicable to the `time_entries` table. If the value is 5, Toggle replicates the past five days’ worth of data for the `time_entries` table during every replication job.

Schema

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

The schema and info displayed below is for version 1.

Depending on your destination, table and column names may not appear as they are outlined below.

clients

The clients table contains info about the clients in your Toggl account.

Replication Method	CDC
Primary Key	id
Replication Key	at
Useful links	Toggl documentation Toggl API method

Join clients with	on
workspaces	clients.wid = workspaces.id
groups	clients.wid = groups.wid
projects	clients.wid = projects.wid clients.id = projects.cid
tags	clients.wid = tags.wid
tasks	clients.wid = tasks.wid
users	clients.wid = users.default_wid
workspace_users	clients.wid = workspace_users.wid

DATE-TIME

cur

STRING

hrate

INTEGER

name

STRING

notes

STRING

wid

INTEGER

groups

The groups table contains info about the groups in your Toggl account.

Replication Method	CDC
Primary Key	id
Replication Key	at
Useful links	Toggl documentation Toggl API method

Join groups with	on
workspaces	groups.wid = workspaces.id
clients	groups.wid = clients.wid
projects	groups.wid = projects.wid
tags	groups.wid = tags.wid
tasks	groups.wid = tasks.wid
users	groups.wid = users.default_wid
workspace_users	groups.wid = workspace_users.wid

DATE-TIME

INTEGER

name

STRING

wid

INTEGER

projects

The projects table contains info about the projects in your Toggl account.

Replication Method	CDC
Primary Key	id
Replication Key	at
Useful links	Toggl documentation Toggl API method

Join projects with	on
workspaces	projects.wid = workspaces.id
clients	projects.wid = clients.wid projects.cid = clients.id
groups	projects.wid = groups.wid
tags	projects.wid = tags.wid
tasks	projects.wid = tasks.wid
users	projects.wid = users.default_wid
workspace_users	projects.wid = workspace_users.wid

active

BOOLEAN

DATE-TIME

billable

BOOLEAN

cid

INTEGER

is_private

BOOLEAN

name

STRING

wid

INTEGER

Join tags with	on
workspaces	tags.wid = workspaces.id
clients	tags.wid = clients.wid
groups	tags.wid = groups.wid
projects	tags.wid = projects.wid
tasks	tags.wid = tasks.wid
users	tags.wid = users.default_wid
workspace_users	tags.wid = workspace_users.wid

tasks

The tasks table contains info about the tasks in your Toggl account.

Note: Tasks are only available for Toggl starter and other paid workspaces.

Replication Method	CDC
Primary Key	id
Replication Key	at
Useful links	Toggl documentation Toggl API method

Join tasks with	on
workspaces	tasks.wid = workspaces.id
clients	tasks.wid = clients.wid
groups	tasks.wid = groups.wid
projects	tasks.wid = projects.wid
tags	tasks.wid = tags.wid
users	tasks.wid = users.default_wid tasks.uid = users.id
workspace_users	tasks.wid = workspace_users.wid
time_entries	tasks.id = time_entries.tid tasks.uid = time_entries.uid

active

BOOLEAN

DATE-TIME

estimated_seconds

INTEGER

name

STRING

pid

INTEGER

uid

INTEGER

wid

INTEGER

time_entries

The time_entries table contains info about time entries. Note: This table uses an attribution window to replicate data. Refer to the Replicating time entry data section for more info.

Time entries and user permissions

The time entries Stitch replicates are dependent upon the user whose API token is used to create the integration in Stitch. Stitch is only able to access the same data as the user whose token is used.

For example: If the user is unable to access a workspace, or is not an Admin in that workspace, Stitch will not be able to replicate time entry data for those workspaces. In this case, only the user’s own time entries will be accessible by Stitch.

If data from a workspace is missing, verify that the user whose API token is being used in Stitch has Admin permissions in that workspace.

Replication Method	CDC
Primary Key	id
Replication Key	updated
Useful links	Toggl API method

Join time_entries with	on
tasks	time_entries.tid = tasks.id time_entries.uid = tasks.uid
users	time_entries.uid = users.id

Join time_entries with

tasks

time_entries.tid = tasks.id

time_entries.uid = tasks.uid

users

time_entries.uid = users.id

billable

NUMBER

client

STRING

cur

STRING

description

STRING

dur

INTEGER

end

DATE-TIME

INTEGER

is_billable

BOOLEAN

pid

INTEGER

project

STRING

start

DATE-TIME

tags

ARRAY

task

STRING

tid

INTEGER

uid

INTEGER

updated

DATE-TIME

use_stop

BOOLEAN

user

STRING

users

The users table contains info about the users in your Toggl account.

Replication Method	CDC
Primary Key	id
Replication Key	at
Useful links	Toggl documentation Toggl API method

Join users with	on
workspaces	users.default_wid = workspaces.id
clients	users.default_wid = clients.wid
groups	users.default_wid = groups.wid
projects	users.default_wid = projects.wid
tags	users.default_wid = tags.wid
tasks	users.default_wid = tasks.wid users.id = tasks.uid
workspace_users	users.default_wid = workspace_users.wid
time_entries	users.id = time_entries.uid

DATE-TIME

beginning_of_week

INTEGER

date_format

STRING

default_wid

INTEGER

email

STRING

fullname

STRING

INTEGER

image_url

STRING

invitation

STRING

jquery_date_format

STRING

jquery_timeofday_format

STRING

language

STRING

new_blog_post

STRING

record_timeline

BOOLEAN

render_timeline

BOOLEAN

retention

INTEGER

should_upgrade

BOOLEAN

sidebar_piechart

BOOLEAN

store_start_and_stop_time

BOOLEAN

timeline_enabled

BOOLEAN

timeline_experiment

BOOLEAN

timeofday_format

STRING

workspace_users

The workspace_users table contains info about the users in a workspace.

Replication Method	CDC
Primary Key	id
Replication Key	at
Useful links	Toggl documentation Toggl API method

Join workspace_users with	on
workspaces	workspace_users.wid = workspaces.id
clients	workspace_users.wid = clients.wid
groups	workspace_users.wid = groups.wid
projects	workspace_users.wid = projects.wid
tags	workspace_users.wid = tags.wid
tasks	workspace_users.wid = tasks.wid
users	workspace_users.wid = users.default_wid

active

BOOLEAN

admin

BOOLEAN

DATE-TIME

email

STRING

INTEGER

invite_url

STRING

name

STRING

uid

INTEGER

wid

INTEGER

workspaces

The workspaces table contains info about the workspaces in your Toggl account.

Replication Method	CDC
Primary Key	id
Replication Key	at
Useful links	Toggl documentation Toggl API method

Join workspaces with	on
clients	workspaces.id = clients.wid
groups	workspaces.id = groups.wid
projects	workspaces.id = projects.wid
tags	workspaces.id = tags.wid
tasks	workspaces.id = tasks.wid
users	workspaces.id = users.default_wid
workspace_users	workspaces.id = workspace_users.wid

admin

BOOLEAN

DATE-TIME

default_currency

STRING

default_hourly_rate

INTEGER

logo_url

STRING

name

STRING

only_admins_may_create_projects

BOOLEAN

only_admins_see_billable_rates

BOOLEAN

premium

BOOLEAN

rounding

INTEGER

rounding_minutes

INTEGER

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here