This integration is powered by Singer's FrontApp tap. For support, visit the GitHub repo or join the Singer Slack.
Front integration summary
Stitch’s Front integration replicates data using the Front API. Refer to the Schema section for a list of objects available for replication.
Front feature snapshot
A high-level look at Stitch's Front (v2) integration, including release status, useful links, and the features supported in Stitch.
| STITCH | |||
| Release status |
Released on November 29, 2023 |
Supported by | |
| Stitch plan |
Standard |
API availability |
Available |
| Singer GitHub repository | |||
| REPLICATION SETTINGS | |||
| Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
| Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
| DATA SELECTION | |||
| Table selection |
Supported |
Column selection |
Supported |
| Select all |
Supported |
||
| TRANSPARENCY | |||
| Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Front
Front setup requirements
To set up Front in Stitch, you need:
-
A Premium or Enterprise Front plan. These plans include API access, which is required to use Stitch’s Front integration. Refer to Front’s pricing page for more info.
Step 1: Generate a Front API token
- Sign into your Front account.
- Click the user menu (your icon) in the top left corner of the page.
- Click Settings.
- In the Company section on the left side of the page, click Plugins & API.
- On the page that displays, click API.
- Click the New Token button.
- On the New Token page, click the Select Scopes dropdown and select the type of resources you want to replicate data from.
- Click Create to create the API token.
Keep the token handy - you’ll need it in the next step to complete the setup.
Step 2: Add Front as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Front icon.
-
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 Front” would create a schema called
stitch_frontin the destination. Note: Schema names cannot be changed after you save the integration. - In the API Token field, paste the Front API token you generated in Step 1.
Step 3: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Front integration. This means that data equal to or newer than this date will be replicated to your data warehouse.
Change this setting if you want to replicate data beyond Front’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 4: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Front integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding 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.
For Front integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up Front, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
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.
Front table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 2 of this integration.
This is the latest version of the Front integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.
accounts_table
The accounts_table table contains data about accounts in your Front account.
|
Key-based Incremental |
|
|
Primary Key |
report_id |
|
Replication Keys |
analytics_date analytics_range |
| Useful links |
|
analytics_date
STRING |
|
analytics_range
STRING |
|
avg_first_response_time NUMBER |
|
avg_handle_time NUMBER |
|
avg_response_time NUMBER |
|
avg_sla_breach_time NUMBER |
|
avg_total_reply_time NUMBER |
|
metric_description STRING |
|
metric_id STRING |
|
new_segments_count NUMBER |
|
num_active_segments_full NUMBER |
|
num_archived_segments NUMBER |
|
num_archived_segments_with_reply NUMBER |
|
num_closed_segments NUMBER |
|
num_csat_survey_response NUMBER |
|
num_messages_received NUMBER |
|
num_messages_sent NUMBER |
|
num_open_segments_end NUMBER |
|
num_open_segments_start NUMBER |
|
num_sla_breach NUMBER |
|
num_workload_segments NUMBER |
|
pct_csat_survey_satisfaction NUMBER |
|
pct_tagged_conversations NUMBER |
|
report_id
STRING |
channels_table
The channels_table table contains data about channels in your Front account.
|
Key-based Incremental |
|
|
Primary Key |
report_id |
|
Replication Keys |
analytics_date analytics_range |
| Useful links |
|
analytics_date
STRING |
|
analytics_range
STRING |
|
avg_first_response_time NUMBER |
|
avg_handle_time NUMBER |
|
avg_response_time NUMBER |
|
avg_sla_breach_time NUMBER |
|
avg_total_reply_time NUMBER |
|
metric_description STRING |
|
metric_id STRING |
|
new_segments_count NUMBER |
|
num_active_segments_full NUMBER |
|
num_archived_segments NUMBER |
|
num_archived_segments_with_reply NUMBER |
|
num_closed_segments NUMBER |
|
num_csat_survey_response NUMBER |
|
num_messages_received NUMBER |
|
num_messages_sent NUMBER |
|
num_open_segments_end NUMBER |
|
num_open_segments_start NUMBER |
|
num_sla_breach NUMBER |
|
num_workload_segments NUMBER |
|
pct_csat_survey_satisfaction NUMBER |
|
pct_tagged_conversations NUMBER |
|
report_id
STRING |
inboxes_table
The inboxes_table table contains data about inboxes in your Front account.
|
Key-based Incremental |
|
|
Primary Key |
report_id |
|
Replication Keys |
analytics_date analytics_range |
| Useful links |
|
analytics_date
STRING |
|
analytics_range
STRING |
|
avg_first_response_time NUMBER |
|
avg_handle_time NUMBER |
|
avg_response_time NUMBER |
|
avg_sla_breach_time NUMBER |
|
avg_total_reply_time NUMBER |
|
metric_description STRING |
|
metric_id STRING |
|
new_segments_count NUMBER |
|
num_active_segments_full NUMBER |
|
num_archived_segments NUMBER |
|
num_archived_segments_with_reply NUMBER |
|
num_closed_segments NUMBER |
|
num_csat_survey_response NUMBER |
|
num_messages_received NUMBER |
|
num_messages_sent NUMBER |
|
num_open_segments_end NUMBER |
|
num_open_segments_start NUMBER |
|
num_sla_breach NUMBER |
|
num_workload_segments NUMBER |
|
pct_csat_survey_satisfaction NUMBER |
|
pct_tagged_conversations NUMBER |
|
report_id
STRING |
tags_table
The tags_table table contains a list of tag statistics since the last completed replication job through the most recent iteration of the defined Incremental Range (day or hour).
This table will include tags in your Front account.
Note: During the historical replication job, all increments (defined using the Incremental Range setting) since the Start Date will be replicated. This will result in the first record for this table being an aggregated record across all tags.
|
Key-based Incremental |
|
|
Primary Key |
report_id |
|
Replication Keys |
analytics_date analytics_range |
| Useful links |
|
analytics_date
STRING |
|
analytics_range
STRING |
|
avg_first_response_time NUMBER |
|
avg_handle_time NUMBER |
|
avg_response_time NUMBER |
|
avg_sla_breach_time NUMBER |
|
avg_total_reply_time NUMBER |
|
metric_description STRING |
|
metric_id STRING |
|
new_segments_count NUMBER |
|
num_active_segments_full NUMBER |
|
num_archived_segments NUMBER |
|
num_archived_segments_with_reply NUMBER |
|
num_closed_segments NUMBER |
|
num_csat_survey_response NUMBER |
|
num_messages_received NUMBER |
|
num_messages_sent NUMBER |
|
num_open_segments_end NUMBER |
|
num_open_segments_start NUMBER |
|
num_sla_breach NUMBER |
|
num_workload_segments NUMBER |
|
pct_csat_survey_satisfaction NUMBER |
|
pct_tagged_conversations NUMBER |
|
report_id
STRING |
teammates_table
The teammates_table table contains data about teammates in your Front account.
|
Key-based Incremental |
|
|
Primary Key |
report_id |
|
Replication Keys |
analytics_date analytics_range |
| Useful links |
|
analytics_date
STRING |
|
analytics_range
STRING |
|
avg_first_response_time NUMBER |
|
avg_handle_time NUMBER |
|
avg_response_time NUMBER |
|
avg_sla_breach_time NUMBER |
|
avg_total_reply_time NUMBER |
|
metric_description STRING |
|
metric_id STRING |
|
new_segments_count NUMBER |
|
num_active_segments_full NUMBER |
|
num_archived_segments NUMBER |
|
num_archived_segments_with_reply NUMBER |
|
num_closed_segments NUMBER |
|
num_csat_survey_response NUMBER |
|
num_messages_received NUMBER |
|
num_messages_sent NUMBER |
|
num_open_segments_end NUMBER |
|
num_open_segments_start NUMBER |
|
num_sla_breach NUMBER |
|
num_workload_segments NUMBER |
|
pct_csat_survey_satisfaction NUMBER |
|
pct_tagged_conversations NUMBER |
|
report_id
STRING |
teams_table
The teams_table table contains data about teams in your Front account.
|
Key-based Incremental |
|
|
Primary Key |
report_id |
|
Replication Keys |
analytics_date analytics_range |
| Useful links |
|
analytics_date
STRING |
|
analytics_range
STRING |
|
avg_first_response_time NUMBER |
|
avg_handle_time NUMBER |
|
avg_response_time NUMBER |
|
avg_sla_breach_time NUMBER |
|
avg_total_reply_time NUMBER |
|
metric_description STRING |
|
metric_id STRING |
|
new_segments_count NUMBER |
|
num_active_segments_full NUMBER |
|
num_archived_segments NUMBER |
|
num_archived_segments_with_reply NUMBER |
|
num_closed_segments NUMBER |
|
num_csat_survey_response NUMBER |
|
num_messages_received NUMBER |
|
num_messages_sent NUMBER |
|
num_open_segments_end NUMBER |
|
num_open_segments_start NUMBER |
|
num_sla_breach NUMBER |
|
num_workload_segments NUMBER |
|
pct_csat_survey_satisfaction NUMBER |
|
pct_tagged_conversations NUMBER |
|
report_id
STRING |
| Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.