Front

Front is a customer communication hub that connects all communication channels such as email, SMS, WhatsApp, social media, and live chat to your team’s inbox. Front also allows you to share knowledge and collaborate in real-time on critical customer messages to provide the best response possible.

Hevo uses Front’s Core API to replicate the data present in your Front account to the desired Destination database or data warehouse for scalable analysis.


Prerequisites

  • An active Front account from which the data is to be ingested.

  • An API Token to allow Hevo to connect to your Front account.


Creating the API Key and Secret

  1. In the Front dashboard, in the top right, click Settings(gear icon).

  2. In the left navigation pane, click Plugins & API.

    Click Plugins and API

  3. In the Plugins page, click API.

    The API tab

  4. In the page displayed, under the Front Tokens section, click New Token to generate your token.

    Click New Token

  5. In the Create Token page, specify the following:

    • NAME: A name for your API token.

    • Scopes: The API permissions needed by Hevo to access your data. To select the scopes, do the following:

      • Click Select scopes, and select the required scopes from the drop-down.

      Read Token permission scopes to know more about scopes.

  6. Click Create.

    Create Token

  7. Once you create the token, in the page displayed, under the Front Tokens section, click on your token to see its details.

    Token details

  8. In the Edit Token page, hover over the TOKEN field, and click Copy to use the token in Hevo to configure Front as a Source.

    Copy Token


Configuring Front as a Source

Perform the following steps to configure Front as the Source in your Pipeline:

  1. Click PIPELINES in the Asset Palette.

  2. Click + CREATE in the Pipelines List View.

  3. In the Select Source Type page, select Front.

  4. In the Configure your Front Source page, specify the following:

    Configure your Front Source

    • Pipeline Name: A unique name for your Pipeline, not exceeding 255 characters.

    • API Token: The API token that you created in your Front account, to enable Hevo to read data.

    • Historical Sync Duration: The duration for which the existing data in the Source must be ingested. Default duration: 3 Months.

  5. Click TEST & CONTINUE.

  6. Proceed to configuring the data ingestion and setting up the Destination.


Data Replication

Default Pipeline Frequency Minimum Pipeline Frequency Maximum Pipeline Frequency Custom Frequency Range (Hrs)
5 Mins 5 Mins 24 Hrs 1-24

Note: The custom frequency must be set in hours, as an integer value. For example, 1, 2, 3 but not 1.5 or 1.75.

  • Historical Data: In the first run of the Pipeline, Hevo ingests historical data for objects on the basis of the historical sync duration selected at the time of creating the Pipeline and loads it to the Destination. Default duration: 3 Months.

  • Incremental Data: Once the historical load is complete, all new and updated records are fetched as per your Pipeline frequency.


Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination database:


Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:

Object Description
Attachments Contains the files attached in a conversation.
Channel Contains the details about the channels in your Front account. A channel is a resource which can send and receive messages.
Comments Contains the list of comments in your Front account. A comment is a private message written by a teammate, visible only to the other teammates.
Comment Mentions Contains the details of the teammates mentioned in a comment.
Contacts Contains details about an individual person.
Contacts Contains the details of a person or entity with whom you have communicated.
Contact Groups Contains the details of the groups a contact belongs to.
Contact Handles Contains the details of the handles used to reach the contact.
Contact Notes Contains the notes added to a contact.
Contact Links Contains the list of all the links associated with a contact.
Conversations Contains the details about conversations. A conversation is a unique thread of messages.
Conversation Tags Contains the tags used in a conversation.
Conversation Links Contains the links used in conversation.
Conversation Followers Contains the details of the teammates following a conversation.
Conversation Inboxes Contains the inbox where a conversation resides.
Conversation Messages Contains the messages in a conversation.
Conversation Message Attachments Contains the attachments present in the messages of a conversation.
Conversation Message Recipient Contains the details of a recipient of the message in a conversation.
Groups Contains the list of groups that a contact belongs to.
Inbox Contains the details of an inbox. An inbox is a container of messages.
Inbox Channels Contains the details of all the channels in an inbox.
Rules Contains the details of the rules in your account. A rule is a set of conditions that triggers automatic actions when they are met.
Rule Actions Contains the list of actions performed by a rule.
Shifts Contains the details of a shift. A shift represents an interval of time repeated over one or more days in a week.
Tags Contains the details about the tags used in your conversations. A tag is a label that is used to classify conversations.
Team Contains the list of teams in your company.
Team is a Full Load object.
Teammate Contains the details of your teammates. A teammate is a Front user, a member of your company
Teammate Shifts Contains information about the shifts of your teammates.
Team Inbox Contains all the inboxes belonging to a team.
Team Teammate Contains the details of all the teammates in a team.

Limitations

Hevo treats a parent and its child objects differently. This section lists the parent objects along with their child objects, and the differences in how you can manage these objects.

Parent Objects Child Objects
Contacts - Contact Notes
Conversations - Messages
- Rules
- Tags
- Shifts
- Comments
- Comment Mentions- Inbox
- Inbox Channels
- Conversation Followers
- Teammates
  • If you skip a parent object, its child objects are also skipped.

  • If you skip a parent object, it is marked as skipped, but its child objects are still shown as active.

  • You only have the option to skip or include child objects, whereas for parent objects, you have additional options such as changing the offset, restarting the object, or running it now.


Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
May-24-2022 1.89 New document.
Last updated on 24 May 2022