Already have an account? Sign in

Onfleet (v1)

Onfleet integration summary

Stitch’s Onfleet integration replicates data using theOnfleet REST API. Refer to theSchema section for a list of objects available for replication.

Onfleet feature snapshot

A high-level look at Stitch's Onfleet (v1) integration, including release status, useful links, and the features supported in Stitch.

Connecting Onfleet

Onfleet setup requirements

To set up Onfleet in Stitch, you need:

• An Onfleet Basic plan or above. Onfleet limits API access to these plans, which is required to use Stitch’s Onfleet integration. Refer toOnfleet’s pricing page for more info.

• Administrator privileges in Onfleet. Onlyadministrators can create API keys, which is required to use Stitch’s Onfleet integration.

Step 1: Create an Onfleet API key

1. Sign into yourOnfleet account.
2. Navigate to theAPI & Webhooks tab.
3. Click the+ button in the bottom of theAPI Keys section to create a new API key.
4. In theName prompt that displays, enter a name for the API key. For example:Stitch
5. ClickCreate Key.

Keep the API key somewhere handy - you’ll need it in the next step.

Step 2: Add Onfleet as a Stitch data source

1. Sign into your Stitch account.

2. On the Stitch Dashboard page, click theAdd Integration button.

3. Click theOnfleet icon.

4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

   For example, the name “Stitch Onfleet” would create a schema calledstitch_onfleet in the destination.Note: Schema names cannot be changed after you save the integration.

5. In theAPI Key field, paste the Onfleet API key you created inStep 1.

6. In theQuota Limit field, enter the percentage of the Onfleet API quota that Stitch is allowed to use. For example: Entering10 would allow Stitch to use 10% of the API quota.

   Onfleet limits API requests to 20 requests per second across all API keys in a given Onfleet account. Refer toOnfleet’s documentation for more info.

Step 3: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Onfleet integration. This means that dataequal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond Onfleet’s default setting of1 year. For a detailed look at historical replication jobs, check out theSyncing Historical SaaS Data guide.

Step 4: Create a replication schedule

In theReplication Frequency section, you’ll create the integration’sreplication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Onfleet integrations support the following replication scheduling methods:

• Replication Frequency

• Anchor Scheduling

• Advanced Scheduling using Cron (Advanced or Premium plans only)

To keep your row usage low, consider setting the integration to replicate less frequently. See theUnderstanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 5: Set objects to replicate

The last step is to select the tables and columns you want to replicate.Learn about the available tables for this integration.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

• Selection options
• Individual tables and columns
• All tables and columns

Initial and historical replication jobs

After you finish setting up Onfleet, itsSync Status may show asPending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, aPending status indicates that Stitch is in the process of scheduling the initial replication job for the integration.This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Onfleet table reference

administrators.id = tasks.creator

administrators.organization = tasks.organization

administrators.id = teams.managers

administrators.organization = organizations.id

administrators.organization = organizations.delegatees

administrators.organization = workers.organization

hubs.id = teams.hub

hubs.teams = teams.id

hubs.teams = workers.teams

organizations.id = administrators.organization

organizations.delegatees = administrators.organization

organizations.id = tasks.organization

organizations.delegatees = tasks.organization

organizations.id = workers.organization

organizations.delegatees = workers.organization

tasks.creator = administrators.id

tasks.organization = administrators.organization

tasks.creator = teams.managers

tasks.id = teams.tasks

tasks.worker = teams.workers

tasks.organization = organizations.id

tasks.organization = organizations.delegatees

tasks.organization = workers.organization

tasks.id = workers.activeTask

tasks.id = workers.tasks

tasks.worker = workers.id

teams.managers = administrators.id

teams.managers = tasks.creator

teams.tasks = tasks.id

teams.workers = tasks.worker

teams.hub = hubs.id

teams.id = hubs.teams

teams.tasks = workers.activeTask

teams.tasks = workers.tasks

teams.id = workers.teams

teams.workers = workers.id

workers.organization = administrators.organization

workers.organization = organizations.id

workers.organization = organizations.delegatees

workers.organization = tasks.organization

workers.activeTask = tasks.id

workers.tasks = tasks.id

workers.id = tasks.worker

workers.activeTask = teams.tasks

workers.tasks = teams.tasks

workers.teams = teams.id

workers.id = teams.workers

workers.teams = hubs.teams

Did this article help? If you have questions or feedback, feel free tosubmit a pull request with your suggestions,open an issue on GitHub, orreach out to us.