Follow Up Boss API Essential Guide

Aug 11, 2024 • 6 minute read

What type of API does Follow Up Boss provide?

Follow Up Boss provides a REST API. Here are the key points about their API:

Type of API

Follow Up Boss uses a REST API

Key Features

It's described as a "simple REST API" that allows developers to integrate their applications quickly
The API is actively being developed and extended while maintaining backward compatibility

Documentation

Follow Up Boss provides documentation covering:

Getting started guide
Authentication methods
Request/response formats
Error handling
Searching capabilities
Pagination details
Rate limiting information
Common filters
Merge fields
Lead submission process
IDX integration
Webhook usage
Embedded app development

Summary

Follow Up Boss offers a standard REST API with typical REST features like resource-based endpoints, HTTP methods for operations, and stateless communication. This aligns with common REST API practices, making it familiar and accessible for many developers. The API appears to be well-documented and actively maintained, providing a range of functionalities for integrating with the Follow Up Boss platform.

Does the Follow Up Boss API have webhooks?

Yes, the official Follow Up Boss API does have webhooks. Here are the key points about webhooks in Follow Up Boss:

Supported Webhook Events

Follow Up Boss supports webhooks for various event types, including:

People events: peopleCreated, peopleUpdated, peopleDeleted, peopleTagsCreated, peopleTagsDeleted
Notes events: notesCreated, notesUpdated, notesDeleted
Emails events: emailsCreated, emailsUpdated
Tasks events: tasksCreated, tasksUpdated, tasksDeleted
Appointments events: appointmentsCreated, appointmentsUpdated, appointmentsDeleted
Text Messages events: textMessagesCreated
Calls events: callsCreated
Email Marketing events: emEventsClicked
Deals events: dealsCreated, dealsUpdated, dealsDeleted
People Events: eventsCreated

Key Points

Webhooks allow you to be notified about events that happen in a Follow Up Boss account.
To use webhooks, you need to register a webhook endpoint URL for the specific events you want to subscribe to.
When an event occurs, Follow Up Boss will send an HTTP POST request to your registered webhook URL with details about the event.
There is a limit of two webhooks per event per system that can be registered.
Only the account owner has permission to create, update or delete webhooks.
Follow Up Boss will retry failed webhook deliveries for up to 8 hours.
Webhook events can be requested individually if needed, which is useful for recovering missed events.

Best Practices

Decouple receiving webhook events from processing them to improve reliability.
Use a unique identifier when registering webhooks, not API keys.
Include a Follow Up Boss account identifier in webhook URLs when setting up webhooks for multiple accounts.

So in summary, Follow Up Boss does offer a robust webhook system that allows you to subscribe to a wide variety of events and receive real-time notifications when those events occur in an account. This enables building integrations that can react quickly to changes in Follow Up Boss data.

Rate Limits and other limitations

The Follow Up Boss API has specific rate limits that developers need to be aware of when integrating with their system. Here are the key points about the API Rate Limits:

Rate Limiting Overview

Rate limiting is enforced by the API based on a sliding 10-second window [1].
The API uses response headers to indicate the current limit, remaining requests, time window, and context [1].
Different endpoints may have different rate limit contexts with varying restrictions [1].

Default Rate Limits

The default rate limits are as follows [1]:

POST.events: Unlimited* (for /v1/events POST requests)
events: 20 requests (for /v1/events GET requests)
global: 250 requests (applies to all other endpoints)

Rate Limit Headers

Each API response includes the following headers [1]:

X-RateLimit-Limit: [limit]
X-RateLimit-Remaining: [remaining requests]
X-RateLimit-Window: 10
X-RateLimit-Context: [context]

Exceeding Rate Limits

When rate limits are exceeded, the API returns a 429 (Too Many Requests) response code [1].
The response includes a Retry-After header indicating how long to wait before retrying [1].
Requests that receive a 429 response are not processed and must be retried [1].

Key Considerations

Systems should respect the 429 header even if X-RateLimit-Remaining shows remaining requests [1].
For systems without a valid X-System-Key header, the allowed rate is much lower (125 requests for the global context) [1].
Rate limit increases can be requested by emailing [email protected] with an explanation of the use case [1].

Best Practices

Implement proper error handling for 429 responses.
Use the response headers to track your remaining requests and adjust your request rate accordingly.
If you need higher limits, contact Follow Up Boss support with a detailed explanation of your use case.
Ensure your system is properly registered with Follow Up Boss and uses the correct X-System-Key header for better rate limits.

By understanding and adhering to these rate limits, developers can ensure their integrations with the Follow Up Boss API remain stable and efficient.

Latest API Version

Based on the search results provided, I can answer your question about the most recent version of the Follow Up Boss API. Here's the information:

Current API Version

The most recent version of the Follow Up Boss API is v1.

Key Points to Consider

The Follow Up Boss API is a REST API that allows developers to integrate their applications quickly.
The API is in active development and will be extended to provide more functionality while maintaining backward compatibility.
The API endpoint URL structure is as follows: https://api.followupboss.com/v1/resource.

API Usage

When using the Follow Up Boss API, keep in mind the following:

HTTPS is required for security; HTTP will not work.
Authentication is done using an API Key with HTTP Basic Authentication over HTTPS.
Every user in Follow Up Boss has a unique API Key that can be obtained from the "Admin" -> "API" screen.
The API Key should be used as the username, and the password can be left blank or set to any value if required by the HTTP client.

Best Practices

Always use HTTPS to ensure the API Key is encrypted during transmission.
Handle the API Key securely, as it provides the same privileges as the user's login credentials.
Include the registered 'X-System' and 'X-System-Key' headers in every API request to identify your system.
When sending contacts to Follow Up Boss, use the events endpoint, which is the preferred method.

By following these guidelines and using the current v1 version of the API, you can effectively integrate your applications with Follow Up Boss while ensuring security and proper functionality.

How to get a Follow Up Boss developer account and API Keys?

Create a Trial Account

Start by creating a trial account on Follow Up Boss:
- Visit https://app.followupboss.com/signup
- This will give you a 14-day free trial account with full features
If you need more time or want to convert to a developer account:
- Email [email protected] to request an extension or conversion to a dev account
- Developer accounts never expire, allowing you to continue working on your integration

Register Your System

Register your system to obtain unique headers for API requests:
- Visit the Registration page
- You'll receive 'X-System' and 'X-System-Key' headers
- These headers should be included in every API request you make

Generate an API Key

Once you have access to your Follow Up Boss account:
- Go to Admin -> API
- Generate a new API key
- Make sure to copy the API key immediately, as it will only be displayed once

Key Points to Consider

HTTPS is required for all API requests to ensure security
Both the System Headers (X-System and X-System-Key) and the API Key are required for every API request
The System Headers identify your system, while the API Key identifies the Follow Up Boss user and account
Handle the API Key securely, as it provides the same privileges as user login credentials

Best Practices

Keep your API Key confidential and secure
Use meaningful names for your API keys when generating them (e.g., the name of your service)
Familiarize yourself with the API documentation and available endpoints
Start with the events endpoint for sending contacts, as it's the preferred method

What can you do with the Follow Up Boss API?

Based on the search results provided, I don't have specific information about the data models that can be interacted with using the Follow Up Boss API. The search results don't contain detailed information about the API's data models and capabilities.

However, I can provide some general information about APIs and common data models in CRM systems like Follow Up Boss:

Common CRM Data Models

CRM systems typically allow interaction with the following data models:

Contacts: Information about individuals or companies
Leads: Potential customers or sales opportunities
Deals/Opportunities: Ongoing sales processes
Tasks: Activities or to-do items related to contacts or deals
Notes: Additional information or comments associated with other records
Users: Information about system users (e.g., sales representatives)
Teams: Groupings of users within the organization

Possible API Interactions

For each of these data models, an API might typically allow:

Creating new records
Retrieving existing records
Updating record information
Deleting records
Searching or filtering records based on specific criteria

Key Points to Consider

The specific data models and operations available would depend on Follow Up Boss's API design and documentation.
API access might be subject to authentication and authorization mechanisms.
There may be rate limits or other restrictions on API usage.
The API might support additional features like webhooks for real-time notifications.

To get accurate and detailed information about the Follow Up Boss API's capabilities and data models, it would be best to consult their official API documentation or contact their support team directly.