Legacy FUB-Initiated Installation

❗️

FUB-Initiated Installation is only available for existing Inbox Apps

This installation type is deprecated and only available if you have an existing published or in-progress Inbox Apps integration. See Installation Lifecycle for the current Partner-Initiated Installation process.

FUB-Initiated Installation Inbox Apps can only be installed from the Follow Up Boss integrations page, and require a multi-leg handshake process using the Activation Webhook URL you provided when beginning development of your Inbox App

Installation Lifecycle

Collect an API Key

You will need a valid API Key to install and use Inbox Apps. You can collect this from the user at the time they are installing the app, or may reuse one you have obtained for a broader integration.

An account owner's API key can be used to install an Inbox App account-wide, or for any active user. A user's API key can only be used to install an Inbox App for that user. It may be helpful to query GET /v1/me to determine what type of API key you have been provided.

Receive Activation Webhook

When a user installs your Inbox App from their integrations page we will make a POST request to your Activation Webhook URL with the following payload.

{
  "authUser": {
    "id": 1,
    "email": "[email protected]"
  },
  "inboxAppId": 1,
  "type": "account"
}

Subscribe to replies

After receiving an Activation Webhook, the Inbox App is put into an "Installing" state and must be activated by you subscribing to replies.

You will subscribe to replies by making a POST request to /v1/inboxApps/:inboxAppId/subscribe and providing a subscriptionUrl that you will receive Inbox App conversation replies at.

Confirm Subscription URL Validity

Follow Up Boss will synchronously make a POST request to your specified subscriptionUrl with the following payload. You must respond with a HTTP 200 OK status code to indicate your receipt.

{
  "test": 1
}

If you fail to respond with HTTP 200 OK in a timely manner, we will reject your subscription request with HTTP 400 Bad Request and it must be retried.

Installation Complete

Once we receive an HTTP 200 OK status code from your subscriptionUrl we will install and activate your Inbox App, responding to your subscription request with HTTP 200 Created.