Connect to Front

You can connect to Front and make it available as a resource. Once complete, you can write queries to interact with the Front API.

Requirements

All users for Retool organizations on Free or Team plans have global Edit permissions and can add, edit, and remove resources. If your organization manages user permissions for resources, you must be a member of a group with Edit all permissions.

To create your Front resource, you need:

• REST API connection details.
• The API version you want to use.
• OAuth 2.0 credentials.

1. Create a Front resource

Retool can connect to almost any API or database, and has built-in integrations for popular data sources. Sign in to your Retool organization and create a new Front resource from the Resources tab.

2. Configure the resource

Provide the necessary details to configure the resource so Retool can connect to Front. Not all settings are required but refer to the Front documentation to learn what is needed.

General

These settings configure the name and location of the resource within Retool.

Name

The name to use for the resource (e.g., Front).

Folder

The folder in which to save the resource.

Description

A brief description of the resource (e.g., Customer data).

Credentials

These settings configure how Retool connects to Front. Make sure to click the Connect with OAuth → button to complete the authentication flow.

API version

The Front API version you want to use.

Share credentials between users

Whether to share authentication credentials between users. All requests to the API will be executed as the authenticated user.

3. Save the resource

Click Create resource to complete the setup. You can then click either Create an app to immediately start building a Retool app or Back to resources to return to the list of resources.

Wrap up

Your Front resource is now ready to use. You write queries to make API requests by specifying the request method and endpoint, additional parameters to include, and the request body.

To verify you can successfully interact with Front, write a test query to retrieve some data. The following example retrieves a channel's details.

Request

GET https://api2.frontapp.com/channels/cha_55cha49

Response

{
  "_links": {
    "self": "https://api2.frontapp.com/channels/cha_55cha49",
    "related": {
      "inbox": "https://api2.frontapp.com/channels/cha_55cha49/inbox",
      "owner": "https://api2.frontapp.com/teams/cha_55cha49"
    }
  },
  "id": "cha_55ful49",
  "address": "team@planet-express.com",
  "type": "smtp",
  "send_as": "team@planet-express.com",
  "settings": {},
  "is_private": false,
  "is_valid": true
}