​
Installation Instructions

Firmhouse is primarily used as a subscription backend and checkout that is run in parallel with an ecommerce platform such as Shopify, but some merchants choose to run Firmhouse standalone without a shopping backend. Your Converge configuration will depend on your specific Firmhouse setup.
1

Navigate to the Firmhouse Admin Dashboard

  1. Navigate to your Firmhouse Dashboard
2

Create your API token

  1. Click on Integrations in the side panel
    integrations
  2. Click on Generate new token, choose No expiration and choose Write as your Access Type, click on Create project access token.
  3. Copy the token you just created, you will need it later.
3

Create a new Server-side source in Converge

  1. In Converge, click on Create a new source
  2. Pick Server-side from the modal
  3. Name your source: e.g. {Storename} Subscriptions
4

Connect and configure the Source

  1. Choose Firmhouse as the app you want to connect.
  2. Enter the Firmhouse access token you created in Step 4.
  3. Review the options and pick how the subscription value of the Started Subscription event in Converge should be calculated. If you are unsure, ask your contact at Firmhouse for a recommendation.
    subscription value
  4. The next step depends on whether you are running Firmhouse side-by-side Shopify, or standalone.
    Choose Shopify as your Product and variant ID and make sure Track Firmhouse invoices as Placed Order events is turned off.
  5. You can ignore shipment date and leave Start Date blank and click on Create Source.

​
Event Spec

This integration auto-tracks the following events on the server with all properties available according to the Converge Event Spec.
Event NameEvent Description
Started SubscriptionWhen a customer starts a subscription.
Placed Order*When a customer places and order.
*Only when configured in the Source configuration.

​
Sales Channels

More on sales channels can be found here. An example of how Converge map Firmhouse events:
FirmhouseConverge MappingDescription
Started SubscriptionwebNew subscription triggered
Placed Orderweb or subscription_contractRecurring placed order events are mapped to “subscription_contract” while first time and one time purchases are mapped to “web”
Placed Shipment OrderofflinePlaced shipment orders