Front API Essential Guide

What type of API does Front provide?

Based on the search results provided, there is no specific information about the type of API that Front uses (e.g. REST, GraphQL, SOAP). The search results contain general information about different types of APIs, but do not mention Front specifically.

To answer this question accurately, we would need to consult Front's official documentation or developer resources. Without that information, I cannot definitively state what type of API Front uses.

However, I can provide some general information about common API types:

Key API Types

1. REST (Representational State Transfer):

   • Resource-based architecture
   • Uses standard HTTP methods (GET, POST, PUT, DELETE, etc.)
   • Typically uses JSON for data exchange
   • Stateless communication

2. GraphQL:

   • Query language for APIs
   • Allows clients to request specific data
   • Single endpoint for all queries
   • Strongly typed schema

3. SOAP (Simple Object Access Protocol):

   • Uses XML for message format
   • Can work over various protocols (HTTP, SMTP, etc.)
   • More rigid and complex compared to REST
   • Good for enterprise-level applications

Considerations

• REST APIs are widely used and well-supported for web and mobile applications.
• GraphQL offers more flexibility in data querying and can be more efficient for complex data requirements.
• SOAP is often used in enterprise environments where strict standards and interoperability are crucial.

To determine which API type Front uses, you would need to check their official documentation or contact their support team for accurate information.

Does the Front API have webhooks?

Yes, the official Front API does have webhooks. Here are the key points about Front's webhook functionality:

Webhook Types

Front offers two types of webhooks:

1. Application webhooks:

   • Recommended for partner integrations
   • Do not require end users to configure the webhook through a rule
   • Send the full event payload
   • Have access to events in shared inboxes

2. Rule webhooks:

   • Good for initial testing and simpler setups
   • Allow setting up a webhook without having a server ready during configuration
   • Can send either the full event payload or an event preview
   • Have access to events in private or shared inboxes where the rule is created

Events You Can Subscribe To

Front webhooks allow you to subscribe to most important events happening in Front. While the documentation doesn't provide an exhaustive list, it mentions that you can be notified about various events such as:

• Messages being received or sent
• Conversations being updated
• Tags being added or removed
• Comments being added
• And many other actions within Front

Events Not Included in Webhooks

Some events are not included in webhooks, such as:

• Moving inbox content to another team
• Mass updating inbox conversation statuses
• Importing historical messages to a channel

Webhook Setup and Configuration

• Application webhooks are configured as features on apps created on the Developers page in Front
• Rule webhooks can be set up through Front's rules system
• For published apps, OAuth is required to authorize Front events to be sent to your webhook

Handling Webhook Events

• Front sends webhook events as HTTP POST requests with the event JSON in the request body
• You should validate the integrity of incoming webhook requests using the provided signature and timestamp headers
• You should respond to webhook events with appropriate HTTP status codes and JSON messages

Best Practices

• Use application webhooks when possible, especially for partner integrations
• Implement proper security measures to validate incoming webhook requests
• Handle retries and potential data loss scenarios
• Consider using tools like RequestBin or UltraHook for initial testing of rule webhooks

In summary, Front's webhook system provides a flexible and powerful way to receive real-time notifications about events occurring within the Front platform, allowing for seamless integration with external systems and automation of workflows.

Rate Limits and other limitations

Here are the key API rate limits for the Front API:

Global Rate Limits

• The global rate limit applies across all public API endpoints [1][2].

• Default rate limits start at 50 requests per 60 seconds and vary based on pricing plan [1][2]:

  • Starter plan: 50 requests per minute (rpm)
  • Growth plan: 100 rpm
  • Scale plan: 200 rpm

• API requests made by partner integrations via OAuth have a separate limit of 120 rpm per company [1][2].

Burst Rate Limits

• Some resource-intensive endpoints have additional "burst" rate limits of 5 calls per second per resource type [1].
• Exports are limited to 1 call per second [1].
• These limits are enforced at the resource level (e.g. per channel, per conversation) [1][2].

Monitoring Rate Limits

• API responses include headers to monitor rate limit usage [2]:
  • X-RateLimit-Limit: Maximum requests allowed
  • X-RateLimit-Remaining: Remaining requests in current window
  • X-RateLimit-Reset: Timestamp when limit resets

Additional Limits

• Some endpoints have a proportional limit of 40% of the global rate limit [2].
• Exceeding limits results in a 429 Too Many Requests response with a Retry-After header [2].

Increasing Limits

• API rate limit add-ons can be purchased to increase limits (300 additional calls per minute per add-on) [1].
• Higher plan tiers or contacting [email protected] can also increase limits [1].

In summary, Front implements tiered global rate limits based on plan, with additional burst limits on certain endpoints. Monitoring headers are provided to track usage, and options exist to increase limits if needed.

Latest API Version

Based on the search results provided, there is no specific mention of the most recent version of the Front API. However, I can provide some relevant information about the Front API:

Key Points:

1. Front offers multiple APIs for different purposes:

   • Core API: The primary backend API for reading, creating, updating, and deleting data across Front's various entities.
   • Channels API: For connecting any messaging platform to Front.
   • Plugin SDK: For embedding custom side-panel apps directly into the Front UI.
   • Chat Widget: For adding a Front-powered chat box to websites.

2. The Core API is the main backend API that provides comprehensive control over all entities in Front, from Contacts to Comments.

3. Front supports OAuth 2.0 and API Tokens for authentication.

4. The API uses Unix time for dates, with a precision of 3 digits for timestamps.

5. Front implements rate limits to ensure acceptable response times and facilitate access for all customers.

Best Practices:

1. When using the API, be aware of the rate limits and implement appropriate handling for rate limit errors.

2. Use the appropriate API for your specific use case (Core API, Channels API, Plugin SDK, etc.).

3. Keep up to date with API news and updates through the Front Developer Community.

4. When working with dates in the API, use Unix time format with 3-digit precision for timestamps.

5. For the most up-to-date information on the API, refer to the official Front Developer Portal and API reference documentation.

While I couldn't find the specific version number of the most recent Front API, it's important to note that APIs are often versioned implicitly through their documentation and endpoints rather than having explicit version numbers. To ensure you're using the most recent version, always refer to the latest documentation on the Front Developer Portal.

How to get a Front developer account and API Keys?

You can create a free developer account for Front by signing up on the Front Developer Portal, even if you already have an existing Front account.

The developer account provides a free environment with everything needed to build with Front's APIs. You can sign up for a developer account at https://dev.frontapp.com.

To get a developer account:

1. Go to the Front Developer Portal at https://dev.frontapp.com.
2. Look for an option to sign up or create a developer account.
3. Fill out the required information to create your free developer account.
4. Once created, you'll have access to a developer environment for testing your integrations.

Best practices:

• Use the separate developer account to build and test your integrations before implementing them in your production Front instance.
• After testing in the developer environment, you can port your app to your production instance by creating an app there and updating the integration to use production credentials.
• Join the Front Developer Community for additional support, to ask questions, and stay updated on API changes.

What can you do with the Front API?

Based on the search results provided, here is a list of data models that can be interacted with using the Front API, along with what is possible for each:

Conversations

• Fetch conversation details
• Update conversation status (open, closed, archived)
• Move conversations between inboxes
• Add or remove tags
• Add or remove links (connections to external systems)
• Assign conversations to teammates
• Create draft replies

Messages

• Fetch message details
• Send new messages
• Create draft messages
• Download message attachments

Contacts

• Create, update, and delete contacts
• Fetch contact details
• Sync contact data with external CRM systems

Inboxes

• List available inboxes
• Fetch inbox details

Teammates

• List teammates
• Fetch teammate details
• Manage user access

Tags

• Create, update, and delete tags
• List available tags
• Add or remove tags from conversations

Links

• Create custom link types for external integrations
• Add or remove links from conversations
• Receive webhook notifications for link-related events

Comments

• Add comments to conversations
• List comments on a conversation

Channels

• List available channels
• Integrate custom communication channels (e.g., SMS, chat) with Front

Analytics

• Export analytics data for team performance and workflow insights

Attachments

• Download attachments from messages and drafts

Drafts

• Create, fetch, and update draft messages

Topics

• Add or remove topics from conversations (similar to links, but for internal categorization)

Webhooks

• Set up webhooks to receive real-time updates on various events in Front

This list covers the main data models and interactions possible with the Front API. The API allows for comprehensive control over most aspects of Front, enabling developers to build custom integrations, automate workflows, and sync data with external systems.