Skip to main content

​
Overview

The Front integration enables you to automate customer communication workflows within your organization. Connect Serval to Front to streamline conversation management, automate inbox operations, and manage your team’s communication infrastructure programmatically.

Key Features

  • Manage conversations and messages
  • Automate inbox routing and tagging
  • Access contacts and accounts
  • Configure channels and teammates

Common Use Cases

  • Automated conversation triage and routing
  • Contact and account data synchronization
  • Message template management
  • Team inbox analytics and reporting

​
Front APIs

The integration provides access to two Front APIs:
APIDescription
Core APIManage conversations, contacts, accounts, inboxes, tags, teammates, and more
Channel APIConfigure and manage application channels and message templates
Anything defined in the Front API Reference can be accessed through Serval.

​
Prerequisites

Before setting up the Front integration, ensure you have admin permissions in your Front account to generate API tokens.

​
Setup Instructions

​
Step 1: Generate Your API Token

1

Open Front Settings

Log in to your Front account and navigate to Settings
2

Go to API Tokens

Navigate to Developers → API tokens
3

Create a New Token

Click New token and provide a descriptive name (e.g., “Serval Integration”)
4

Configure Token Scopes

Select the appropriate scopes for your use case. At minimum, enable Access resources with Shared resources for the workspaces you want Serval to access.
5

Save Your Token

Copy the generated API token and store it in a secure location
API tokens are shown only once when created. Make sure to copy and save it before closing the dialog.

​
Step 2: Configure Integration in Serval

  1. In Serval, go to Apps → Available → Front → Connect
  2. Click the Connect button
  3. Enter your configuration details:
​
apiKey
string
required
Your Front API token from Step 1. This authenticates all API requests to Front using Bearer token authentication.
  1. Click Submit to establish the integration

​
Step 3: Verify the Connection

  1. After submitting, navigate to the Front integration page in Serval
  2. Click the API tab
  3. Click Run on the health check to test the connection
If the health check passes, your Front integration is ready to use.

​
Token Scopes

Front API tokens support granular permissions. Configure scopes based on what Serval needs to access:
ScopeDescription
Shared resourcesAccess shared inboxes, conversations, tags, and workspace-level resources
Private resourcesAccess individual teammate resources (requires teammate opt-in)
Global resourcesAccess company-level resources like teams, accounts, and rules
Front recommends limiting permissions to only what your integration needs. You can update scopes later by editing the token in Front settings.

​
Rate Limits

The Front API enforces rate limits to ensure fair usage:
Rate limits vary by endpoint and plan. If you exceed the limit, the API returns a 429 Too Many Requests response with a Retry-After header indicating when you can retry.

​
Additional Resources

Front API Reference

Complete API reference for all Front Core and Channel API endpoints

Authentication Guide

Detailed guide on API tokens, OAuth, and token scopes
Need help? Contact support@serval.com for assistance with your Front integration.