Front Data Source

Follow the instructions below to create a new data flow that ingests data from a Front source in Nexla.

Front

Create a New Data Flow

1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

2. Select the Front connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Front instance, and click Next; or, create a new Front credential for use in this flow.

3. In Nexla, Front data sources can be created using pre-built endpoint templates, which expedite source setup for common Front endpoints. Each template is designed specifically for the corresponding Front endpoint, making source configuration easy and efficient.
   • To configure this source using a template, follow the instructions in Configure Using a Template.

   Front sources can also be configured manually, allowing you to ingest data from Front endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
   • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Front endpoints. Each template is designed specifically for the corresponding Front endpoint, making data source setup easy and efficient.

Endpoint Settings

• Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

  List Contacts

  List the contacts of the company.

  • This endpoint automatically retrieves all contacts from your Front account. No additional configuration is required beyond selecting this endpoint template.
  • The endpoint uses GET requests to https://api2.frontapp.com/contacts. The endpoint URL is automatically constructed based on the Front API base URL.
  • The endpoint uses token-based pagination, automatically fetching additional pages as needed. When a response includes a _pagination.next value, Nexla automatically uses it as the page_token query parameter for the subsequent request to fetch the next page of results.
  • The endpoint will return all contacts in your Front account. The response data is extracted from the _results array in the API response ($._results[*]), with each contact record processed individually.

  This endpoint retrieves all contacts associated with your Front company. The endpoint uses token-based pagination (iteration.type: paging.next.token) through the _pagination.next mechanism. When a response includes a _pagination.next value, Nexla automatically uses it as the page_token query parameter for the subsequent request. The response data path is $._results[*], which extracts all items from the _results array in the API response. For detailed information about listing contacts, see the Front API documentation.

  List Accounts

  List the accounts of the company.

  • This endpoint automatically retrieves all accounts from your Front account. No additional configuration is required beyond selecting this endpoint template.
  • The endpoint uses GET requests to https://api2.frontapp.com/accounts. The endpoint URL is automatically constructed based on the Front API base URL.
  • The endpoint uses token-based pagination, automatically fetching additional pages as needed. When a response includes a _pagination.next value, Nexla automatically uses it as the page_token query parameter for the subsequent request to fetch the next page of results.
  • The endpoint will return all accounts in your Front account. The response data is extracted from the _results array in the API response ($._results[*]), with each account record processed individually.

  This endpoint retrieves all accounts associated with your Front company. The endpoint uses token-based pagination (iteration.type: paging.next.token) through the _pagination.next mechanism. When a response includes a _pagination.next value, Nexla automatically uses it as the page_token query parameter for the subsequent request. The response data path is $._results[*], which extracts all items from the _results array in the API response. For detailed information about listing accounts, see the Front API documentation.

  List Channels

  List the channels of the company.

  • This endpoint automatically retrieves all channels from your Front account. No additional configuration is required beyond selecting this endpoint template.
  • The endpoint uses GET requests to https://api2.frontapp.com/channels. The endpoint URL is automatically constructed based on the Front API base URL.
  • The endpoint does not use pagination and returns all channels in a single request.
  • The endpoint will return all channels in your Front account. The response data is extracted from the _results array in the API response ($._results[*]), with each channel record processed individually.

  This endpoint retrieves all communication channels configured in your Front account. Channels represent the different ways your team communicates with customers (e.g., email, phone, chat). The endpoint uses a static URL (iteration.type: static.url) and does not require pagination. The response data path is $._results[*], which extracts all items from the _results array in the API response. For detailed information about listing channels, see the Front API documentation.

  List Events

  Lists all the detailed events which occurred in the inboxes of the company ordered in reverse chronological order (newest first).

  • This endpoint automatically retrieves all events from your Front account. No additional configuration is required beyond selecting this endpoint template.
  • The endpoint uses GET requests to https://api2.frontapp.com/events. The endpoint URL is automatically constructed based on the Front API base URL.
  • The endpoint uses token-based pagination, automatically fetching additional pages as needed. When a response includes a _pagination.next value, Nexla automatically uses it as the page_token query parameter for the subsequent request to fetch the next page of results.
  • The endpoint will return all events in your Front account, ordered from newest to oldest. The response data is extracted from the _results array in the API response ($._results[*]), with each event record processed individually.

  This endpoint retrieves all detailed events that occurred in your Front inboxes. Events represent various actions and changes in your Front account, such as message sends, replies, assignments, and status changes. Events are returned in reverse chronological order (newest first). The endpoint uses token-based pagination (iteration.type: paging.next.token) through the _pagination.next mechanism. When a response includes a _pagination.next value, Nexla automatically uses it as the page_token query parameter for the subsequent request. The response data path is $._results[*], which extracts all items from the _results array in the API response. For detailed information about listing events, see the Front API documentation.

  List Conversations

  List the conversations in the company in reverse chronological order (most recently updated first).

  • This endpoint automatically retrieves all conversations from your Front account. No additional configuration is required beyond selecting this endpoint template.
  • The endpoint uses GET requests to https://api2.frontapp.com/conversations. The endpoint URL is automatically constructed based on the Front API base URL.
  • The endpoint uses token-based pagination, automatically fetching additional pages as needed. When a response includes a _pagination.next value, Nexla automatically uses it as the page_token query parameter for the subsequent request to fetch the next page of results.
  • The endpoint will return all conversations in your Front account, ordered from most recently updated to least recently updated. The response data is extracted from the _results array in the API response ($._results[*]), with each conversation record processed individually.

  This endpoint retrieves all conversations in your Front account. Conversations represent threads of communication with customers and are ordered by most recently updated first. The endpoint uses token-based pagination (iteration.type: paging.next.token) through the _pagination.next mechanism. When a response includes a _pagination.next value, Nexla automatically uses it as the page_token query parameter for the subsequent request. The response data path is $._results[*], which extracts all items from the _results array in the API response. For detailed information about listing conversations, see the Front API documentation.

  List all company rules

  List the company rules.

  • This endpoint automatically retrieves all company rules from your Front account. No additional configuration is required beyond selecting this endpoint template.
  • The endpoint uses GET requests to https://api2.frontapp.com/company/rules. The endpoint URL is automatically constructed based on the Front API base URL.
  • The endpoint does not use pagination and returns all company rules in a single request.
  • The endpoint will return all company rules in your Front account. The response data is extracted from the _results array in the API response ($._results[*]), with each rule record processed individually.

  This endpoint retrieves all company-level rules configured in your Front account. Company rules define automated workflows and actions that apply across your entire organization. The endpoint uses a static URL (iteration.type: static.url) and does not require pagination. The response data path is $._results[*], which extracts all items from the _results array in the API response. For detailed information about listing company rules, see the Front API documentation.

  List Rules

  List the rules of the company.

  • This endpoint automatically retrieves all rules from your Front account. No additional configuration is required beyond selecting this endpoint template.
  • The endpoint uses GET requests to https://api2.frontapp.com/rules. The endpoint URL is automatically constructed based on the Front API base URL.
  • The endpoint does not use pagination and returns all rules in a single request.
  • The endpoint will return all rules in your Front account. The response data is extracted from the _results array in the API response ($._results[*]), with each rule record processed individually.

  This endpoint retrieves all rules configured in your Front account. Rules define automated workflows and actions that can be applied to conversations, messages, and other Front resources. The endpoint uses a static URL (iteration.type: static.url) and does not require pagination. The response data path is $._results[*], which extracts all items from the _results array in the API response. For detailed information about listing rules, see the Front API documentation.

Endpoint Testing

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually

Front data sources can be manually configured to ingest data from any valid Front API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Front sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request parameters.

API Method

1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

2. Select the API method that will be used for calls to the Front API from the Method pulldown menu. The most common methods are:

   • GET: For retrieving data from the API
   • POST: For sending data to the API or triggering actions
   • PUT: For updating existing data
   • PATCH: For partial updates to existing data
   • DELETE: For removing data

API Endpoint URL

3. Enter the URL of the Front API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Front API endpoints typically follow the pattern https://api2.frontapp.com/{endpoint_path}.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires API Token authentication via the Authorization: Bearer {token} header, which is handled automatically by your credential configuration. For detailed information about Front API endpoints and available APIs, see the Front API documentation.