From e7475440e65c433533dc06e92a4781f2e28aec3c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A9lanie=20Vistry?= Date: Thu, 2 Jul 2026 17:31:12 +0200 Subject: [PATCH] Added new v3 --- .../frontapp/v3/frontapp-v3-tables.yml | 86 ++++++++ .../frontapp/v3/json/accounts_table.json | 185 ++++++++++++++++++ .../frontapp/v3/json/channels_table.json | 185 ++++++++++++++++++ .../frontapp/v3/json/inboxes_table.json | 185 ++++++++++++++++++ .../schemas/frontapp/v3/json/tags_table.json | 185 ++++++++++++++++++ .../frontapp/v3/json/teammates_table.json | 185 ++++++++++++++++++ .../schemas/frontapp/v3/json/teams_table.json | 185 ++++++++++++++++++ _data/taps/versions/frontapp.yml | 6 +- _saas-integrations/front/v2/front-v2.md | 4 +- _saas-integrations/front/v3/front-v3.md | 135 +++++++++++++ 10 files changed, 1338 insertions(+), 3 deletions(-) create mode 100644 _data/taps/schemas/frontapp/v3/frontapp-v3-tables.yml create mode 100644 _data/taps/schemas/frontapp/v3/json/accounts_table.json create mode 100644 _data/taps/schemas/frontapp/v3/json/channels_table.json create mode 100644 _data/taps/schemas/frontapp/v3/json/inboxes_table.json create mode 100644 _data/taps/schemas/frontapp/v3/json/tags_table.json create mode 100644 _data/taps/schemas/frontapp/v3/json/teammates_table.json create mode 100644 _data/taps/schemas/frontapp/v3/json/teams_table.json create mode 100644 _saas-integrations/front/v3/front-v3.md diff --git a/_data/taps/schemas/frontapp/v3/frontapp-v3-tables.yml b/_data/taps/schemas/frontapp/v3/frontapp-v3-tables.yml new file mode 100644 index 000000000..7cc3e8532 --- /dev/null +++ b/_data/taps/schemas/frontapp/v3/frontapp-v3-tables.yml @@ -0,0 +1,86 @@ +tap: frontapp +version: '3' +tap-repo-schemas: true +tables: +- name: accounts_table + description: The `{{ table.name }}` table contains data about accounts in your {{ + integration.display_name }} account. + links: + doc-link: https://dev.frontapp.com/reference/analytics + singer-schema: https://github.com/singer-io/tap-frontapp/blob/master/tap_frontapp/schemas/accounts_table.json + table-details: + replication-method: Key-based Incremental + primary-key: report_id + replication-keys: + - analytics_date + - analytics_range +- name: channels_table + description: The `{{ table.name }}` table contains data about channels in your {{ + integration.display_name }} account. + links: + doc-link: https://dev.frontapp.com/reference/analytics + singer-schema: https://github.com/singer-io/tap-frontapp/blob/master/tap_frontapp/schemas/channels_table.json + table-details: + replication-method: Key-based Incremental + primary-key: report_id + replication-keys: + - analytics_date + - analytics_range +- name: inboxes_table + description: The `{{ table.name }}` table contains data about inboxes in your {{ + integration.display_name }} account. + links: + doc-link: https://dev.frontapp.com/reference/analytics + singer-schema: https://github.com/singer-io/tap-frontapp/blob/master/tap_frontapp/schemas/inboxes_table.json + table-details: + replication-method: Key-based Incremental + primary-key: report_id + replication-keys: + - analytics_date + - analytics_range +- name: tags_table + description: 'The `{{ table.name }}` table contains a list of tag statistics since + the last completed replication job through the most recent iteration of the defined + [**Incremental Range**](#add-stitch-data-source) (day or hour). + + This table will include tags in your {{ integration.display_name }} 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. + + ' + links: + doc-link: https://dev.frontapp.com/reference/analytics + singer-schema: https://github.com/singer-io/tap-frontapp/blob/master/tap_frontapp/schemas/tags_table.json + table-details: + replication-method: Key-based Incremental + primary-key: report_id + replication-keys: + - analytics_date + - analytics_range +- name: teammates_table + description: The `{{ table.name }}` table contains data about teammates in your + {{ integration.display_name }} account. + links: + doc-link: https://dev.frontapp.com/reference/analytics + singer-schema: https://github.com/singer-io/tap-frontapp/blob/master/tap_frontapp/schemas/teammates_table.json + table-details: + replication-method: Key-based Incremental + primary-key: report_id + replication-keys: + - analytics_date + - analytics_range +- name: teams_table + description: The `{{ table.name }}` table contains data about teams in your {{ integration.display_name + }} account. + links: + doc-link: https://dev.frontapp.com/reference/analytics + singer-schema: https://github.com/singer-io/tap-frontapp/blob/master/tap_frontapp/schemas/teams_table.json + table-details: + replication-method: Key-based Incremental + primary-key: report_id + replication-keys: + - analytics_date + - analytics_range \ No newline at end of file diff --git a/_data/taps/schemas/frontapp/v3/json/accounts_table.json b/_data/taps/schemas/frontapp/v3/json/accounts_table.json new file mode 100644 index 000000000..3a05d151f --- /dev/null +++ b/_data/taps/schemas/frontapp/v3/json/accounts_table.json @@ -0,0 +1,185 @@ +{ + "additionalProperties": false, + "bookmark_properties": [ + "analytics_date", + "analytics_range" + ], + "key_properties": [ + "report_id" + ], + "properties": { + "analytics_date": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "analytics_range": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "avg_first_response_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_handle_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_response_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_sla_breach_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_total_reply_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "metric_description": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "metric_id": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "new_segments_count": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_active_segments_full": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_archived_segments": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_archived_segments_with_reply": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_closed_segments": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_csat_survey_response": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_messages_received": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_messages_sent": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_open_segments_end": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_open_segments_start": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_sla_breach": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_workload_segments": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "pct_csat_survey_satisfaction": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "pct_tagged_conversations": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "report_id": { + "selected": true, + "type": [ + "null", + "string" + ] + } + }, + "selected": true, + "type": [ + "null", + "object" + ] +} \ No newline at end of file diff --git a/_data/taps/schemas/frontapp/v3/json/channels_table.json b/_data/taps/schemas/frontapp/v3/json/channels_table.json new file mode 100644 index 000000000..3a05d151f --- /dev/null +++ b/_data/taps/schemas/frontapp/v3/json/channels_table.json @@ -0,0 +1,185 @@ +{ + "additionalProperties": false, + "bookmark_properties": [ + "analytics_date", + "analytics_range" + ], + "key_properties": [ + "report_id" + ], + "properties": { + "analytics_date": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "analytics_range": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "avg_first_response_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_handle_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_response_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_sla_breach_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_total_reply_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "metric_description": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "metric_id": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "new_segments_count": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_active_segments_full": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_archived_segments": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_archived_segments_with_reply": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_closed_segments": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_csat_survey_response": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_messages_received": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_messages_sent": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_open_segments_end": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_open_segments_start": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_sla_breach": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_workload_segments": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "pct_csat_survey_satisfaction": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "pct_tagged_conversations": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "report_id": { + "selected": true, + "type": [ + "null", + "string" + ] + } + }, + "selected": true, + "type": [ + "null", + "object" + ] +} \ No newline at end of file diff --git a/_data/taps/schemas/frontapp/v3/json/inboxes_table.json b/_data/taps/schemas/frontapp/v3/json/inboxes_table.json new file mode 100644 index 000000000..3a05d151f --- /dev/null +++ b/_data/taps/schemas/frontapp/v3/json/inboxes_table.json @@ -0,0 +1,185 @@ +{ + "additionalProperties": false, + "bookmark_properties": [ + "analytics_date", + "analytics_range" + ], + "key_properties": [ + "report_id" + ], + "properties": { + "analytics_date": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "analytics_range": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "avg_first_response_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_handle_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_response_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_sla_breach_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_total_reply_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "metric_description": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "metric_id": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "new_segments_count": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_active_segments_full": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_archived_segments": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_archived_segments_with_reply": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_closed_segments": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_csat_survey_response": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_messages_received": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_messages_sent": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_open_segments_end": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_open_segments_start": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_sla_breach": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_workload_segments": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "pct_csat_survey_satisfaction": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "pct_tagged_conversations": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "report_id": { + "selected": true, + "type": [ + "null", + "string" + ] + } + }, + "selected": true, + "type": [ + "null", + "object" + ] +} \ No newline at end of file diff --git a/_data/taps/schemas/frontapp/v3/json/tags_table.json b/_data/taps/schemas/frontapp/v3/json/tags_table.json new file mode 100644 index 000000000..3a05d151f --- /dev/null +++ b/_data/taps/schemas/frontapp/v3/json/tags_table.json @@ -0,0 +1,185 @@ +{ + "additionalProperties": false, + "bookmark_properties": [ + "analytics_date", + "analytics_range" + ], + "key_properties": [ + "report_id" + ], + "properties": { + "analytics_date": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "analytics_range": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "avg_first_response_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_handle_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_response_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_sla_breach_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_total_reply_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "metric_description": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "metric_id": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "new_segments_count": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_active_segments_full": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_archived_segments": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_archived_segments_with_reply": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_closed_segments": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_csat_survey_response": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_messages_received": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_messages_sent": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_open_segments_end": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_open_segments_start": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_sla_breach": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_workload_segments": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "pct_csat_survey_satisfaction": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "pct_tagged_conversations": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "report_id": { + "selected": true, + "type": [ + "null", + "string" + ] + } + }, + "selected": true, + "type": [ + "null", + "object" + ] +} \ No newline at end of file diff --git a/_data/taps/schemas/frontapp/v3/json/teammates_table.json b/_data/taps/schemas/frontapp/v3/json/teammates_table.json new file mode 100644 index 000000000..3a05d151f --- /dev/null +++ b/_data/taps/schemas/frontapp/v3/json/teammates_table.json @@ -0,0 +1,185 @@ +{ + "additionalProperties": false, + "bookmark_properties": [ + "analytics_date", + "analytics_range" + ], + "key_properties": [ + "report_id" + ], + "properties": { + "analytics_date": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "analytics_range": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "avg_first_response_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_handle_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_response_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_sla_breach_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_total_reply_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "metric_description": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "metric_id": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "new_segments_count": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_active_segments_full": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_archived_segments": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_archived_segments_with_reply": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_closed_segments": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_csat_survey_response": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_messages_received": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_messages_sent": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_open_segments_end": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_open_segments_start": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_sla_breach": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_workload_segments": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "pct_csat_survey_satisfaction": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "pct_tagged_conversations": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "report_id": { + "selected": true, + "type": [ + "null", + "string" + ] + } + }, + "selected": true, + "type": [ + "null", + "object" + ] +} \ No newline at end of file diff --git a/_data/taps/schemas/frontapp/v3/json/teams_table.json b/_data/taps/schemas/frontapp/v3/json/teams_table.json new file mode 100644 index 000000000..3a05d151f --- /dev/null +++ b/_data/taps/schemas/frontapp/v3/json/teams_table.json @@ -0,0 +1,185 @@ +{ + "additionalProperties": false, + "bookmark_properties": [ + "analytics_date", + "analytics_range" + ], + "key_properties": [ + "report_id" + ], + "properties": { + "analytics_date": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "analytics_range": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "avg_first_response_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_handle_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_response_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_sla_breach_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "avg_total_reply_time": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "metric_description": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "metric_id": { + "selected": true, + "type": [ + "null", + "string" + ] + }, + "new_segments_count": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_active_segments_full": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_archived_segments": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_archived_segments_with_reply": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_closed_segments": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_csat_survey_response": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_messages_received": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_messages_sent": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_open_segments_end": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_open_segments_start": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_sla_breach": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "num_workload_segments": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "pct_csat_survey_satisfaction": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "pct_tagged_conversations": { + "selected": true, + "type": [ + "null", + "number" + ] + }, + "report_id": { + "selected": true, + "type": [ + "null", + "string" + ] + } + }, + "selected": true, + "type": [ + "null", + "object" + ] +} \ No newline at end of file diff --git a/_data/taps/versions/frontapp.yml b/_data/taps/versions/frontapp.yml index e2a72789b..ac642bcd9 100644 --- a/_data/taps/versions/frontapp.yml +++ b/_data/taps/versions/frontapp.yml @@ -2,11 +2,15 @@ # FRONT VERSIONS # # -------------------------- # -latest-version: "2" +latest-version: "3" released-versions: + - number: "3" + date-released: "June 22, 2026" + - number: "2" date-released: "November 29, 2023" + date-last-connection: "June 22, 2026" - number: "1" date-released: "January 16, 2019" diff --git a/_saas-integrations/front/v2/front-v2.md b/_saas-integrations/front/v2/front-v2.md index 517c96e51..d3192b307 100644 --- a/_saas-integrations/front/v2/front-v2.md +++ b/_saas-integrations/front/v2/front-v2.md @@ -13,11 +13,11 @@ # -------------------------- # title: Front (v2) -permalink: /integrations/saas/front +permalink: /integrations/saas/front/v2 keywords: front, integration, schema, etl front, front etl, front schema summary: "Connection instructions, replication info, and schema details for Stitch's Front integration." layout: singer -# input: false +input: false key: "frontapp-setup" diff --git a/_saas-integrations/front/v3/front-v3.md b/_saas-integrations/front/v3/front-v3.md new file mode 100644 index 000000000..4270adabe --- /dev/null +++ b/_saas-integrations/front/v3/front-v3.md @@ -0,0 +1,135 @@ +--- +# -------------------------- # +# USING THIS TEMPLATE # +# -------------------------- # + +## NEED HELP USING THIS TEMPLATE? SEE: +## https://docs-about-stitch-docs.netlify.com/reference/integration-templates/saas/ +## FOR INSTRUCTIONS & REFERENCE INFO + + +# -------------------------- # +# Page & Formatting # +# -------------------------- # + +title: Front (v3) +permalink: /integrations/saas/front +keywords: front, integration, schema, etl front, front etl, front schema +summary: "Connection instructions, replication info, and schema details for Stitch's Front integration." +layout: singer +# input: false + +key: "frontapp-setup" + +# -------------------------- # +# Tap Details # +# -------------------------- # + +name: "frontapp" +display_name: "Front" + +singer: true +tap-name: "FrontApp" +repo-url: https://github.com/singer-io/tap-frontapp + +this-version: "3" + +api: | + [Front API](https://dev.frontapp.com/){:target="new"} + +# -------------------------- # +# Stitch Details # +# -------------------------- # + +certified: false + +historical: "1 year" +frequency: "30 minutes" +tier: "Standard" +status-url: "https://www.frontstatus.com/" + +api-type: "platform.frontapp" + +anchor-scheduling: true +cron-scheduling: true + +extraction-logs: true +loading-reports: true + +table-selection: true +column-selection: true + +# attribution-window: "# days" +# attribution-is-configurable: + +# setup-name: "" + +# -------------------------- # +# Feature Summary # +# -------------------------- # + +feature-summary: | + Stitch's {{ integration.display_name }} integration replicates data using the {{ integration.api | flatify | strip }}. Refer to the [Schema](#schema) section for a list of objects available for replication. + + +# -------------------------- # +# Setup Instructions # +# -------------------------- # + +requirements-list: + - item: | + **A Premium or Enterprise {{ integration.display_name }} plan**. These plans include API access, which is required to use Stitch's {{ integration.display_name }} integration. Refer to [{{ integration.display_name }}'s pricing page for more info](https://frontapp.com/pricing){:target="new"}. + +setup-steps: + - title: "Generate a {{ integration.display_name }} API token" + anchor: "generate-front-api-token" + content: | + {% include layout/inline_image.html type="right" file="integrations/front-create-api-token.png" alt="The New API token page in Front" max-width="550px" %} + + 1. Sign into your [{{ integration.display_name }} account](https://app.frontapp.com/){:target="new"}. + 2. Click the user menu (your icon) in the top left corner of the page. + 3. Click **Settings**. + 4. In the **Company** section on the left side of the page, click **Plugins & API**. + 5. On the page that displays, click **API**. + 6. Click the **New Token** button. + 7. On the **New Token** page, click the **Select Scopes** dropdown and select the type of resources you want to replicate data from. + 8. Click **Create** to create the API token. + + Keep the token handy - you'll need it in the next step to complete the setup. + +# Per FrontApp support on 12/18/18: +# If you use the shared namespace, you will get analytics for all shared inboxes across all teams. If you use the private namespace, you will get analytics for private inboxes that users have marked accessible to the public API (is an individual user setting). +# I'm not sure how this works with the Get Analtyics endpoint, since this metric seems to be team-focused. + + - title: "Add {{ integration.display_name }} as a Stitch data source" + anchor: "add-stitch-data-source" + content: | + {% include integrations/shared-setup/connection-setup.html %} + 4. In the **API Token** field, paste the {{ integration.display_name }} API token you generated in [Step 1](#generate-front-api-token). + 5. From the **Incremental Range** dropdown, select one of the following options: + - **Daily** - Data will be aggregated on a daily basis. + - **Hourly** - Data will be aggregated on an hourly basis. + - title: "Define the historical replication start date" + anchor: "define-historical-sync" + content: | + {% include integrations/saas/setup/historical-sync.html %} + + - title: "Create a replication schedule" + anchor: "define-rep-frequency" + content: | + {% include integrations/shared-setup/replication-frequency.html %} + + - title: "Set objects to replicate" + anchor: "setting-data-to-replicate" + content: | + {% include integrations/shared-setup/data-selection/object-selection.html %} + +# -------------------------- # +# Integration Tables # +# -------------------------- # + +# Looking for the table schemas & info? +# Each table has a its own .md file in /_integration-schemas/front +--- +{% assign integration = page %} +{% include misc/data-files.html %} \ No newline at end of file