Introduction

At Framework, we believe that data management should be robust and flexible to your specific needs. To that end, we offer multiple ways to share, export, and integrate your data. We are also continuously adding to these capabilities and welcome feedback on use cases not currently covered at support@framework.so. We're happy to work with you to accommodate new data requests.

Types of Integrations

Integrations can be split into three types, each carrying a different levels of flexibility and setup complexity.

1. Zapier
2. Third-Party Integrations
3. Framework API

1. Zapier

We currently support the following Zapier triggers:

• Member joins challenge
• Member joins community
• Member purchases product
• Member completes challenge (coming soon)

For more information on how to use Zapier, have a look at their quick start guide.

Installation
To setup connect your Framework community and Zapier account, open Admin > Settings and scroll down to Integrations. Next to the Zapier logo, click Connect to connect your Zapier account to Framework.

You will be redirected to a Zapier sign in page, on which you should enter your Zapier account credentials to sign in. If you don’t have a Zapier account, you will first need to create one before proceeding with the aforementioned steps.

After signing into your Zapier account, you will be redirected to Framework and the integration will be complete. You will see in the Integrations table, under Details, an API key.

Usage
To use the Zapier integration, navigate to your Zapier account and go to your Zaps. Then, Make a Zap, and choose Framework as your app. Follow the Zapier prompts to create the Zap.

When prompted to enter your API key, enter the key obtained during Installation.

You're now ready to create a Zap!

Uninstallation
To uninstall Zapier in your community, navigate to the Integrations page in your community’s Administrator View. Click Disconnect to disconnect your Zapier account. To fully revoke Framework's access to Zapier, log into your Zapier account and navigate to the Zapier App Marketplace. Click Manage > Installed Apps, or search for the Framework app. Click the Framework app and click Uninstall.

2. Third Party Integration

Zapier is great for sharing basic data between Framework and another app in your stack. However, in some cases, the desired integration is more deeper than what Zapier allows for. In these cases, we support direct, third-party integrations. We currently support such integrations for Zoom and Shopify, however, more are coming soon. Please get in touch if there is a direct integration that you'd like to see.

Shopify

Enable the Integration

With your community open, navigate to Admin > Settings > Integrations and click the Enable button to the right of the Shopify logo. Once enabled, there will be a box with a URL to copy (as shown below):

Click the Copy button. Then, open the admin side of your Shopify storefront. Click Settings in the bottom left corner. In the left menu, click Notifications. Scroll to the bottom until you see the Webhooks section. Click Create webhook. You should see a dialog that looks like this:

In the Event dropdown, select Order payment. Then, paste the URL you copied from Framework into the URL field. Finally, select 2022-07 in the Webhook API version dropdown. Once all is configured, the dialog should look similar to this:

Click Save.

Configuring a Product

With the Shopify integration enabled and configured, you can now associate Framework products with Shopify products. You can grant users access to 1 or more Framework products when a product is purchased through Shopify.

To connect Shopify and Framework products, navigate to Payments in the Framework admin. All products you have are listed in the Products table at the bottom of the page. If you do not yet have products configured in Framework, refer to the Products documentation.

Click into the product that you wish to connect to Shopify. Scroll down until you see Shopify Configuration. Enable it. In the Shopify Product ID field, enter your Shopify product ID. You can find the Shopify product ID  by navigating to the Products table in the Shopify admin, clicking into the desired product, and copying the product ID from the URL. The product ID will be the last segment of the URL.

In this example, the product ID is 7775433523365. Your product ID will differ.

Copy the product ID, and paste that into the Shopify Product ID field of the Framework product. Example shown below:

That's it!

User Experience

Your users will be sent an email containing a code to redeem their product(s) on Framework upon payment of a Shopify product. In order to make this experience as smooth as possible, we recommend disabling the ability of users to checkout with a phone number. We cannot yet deliver product redemption codes via text message. To turn off checkout with phone numbers, click Settings in the lower left corner of the Shopify admin. In the left menu that appears, click Checkout and accounts. Scroll to the section Customer contact method and choose Email:

With this configured, your users will provide an email address during Shopify checkout. This is the email address will be used to send a link that users can click to redeem their Framework products.

Zoom

Connect Framework to your Zoom account and automatically generate Zoom links for any relevant meetings.

Click Connect ****to connect your Zoom account to Framework. You will be redirected to the Zoom sign in page, on which you should enter your Zoom account credentials to sign in. If you don’t have a Zoom account, you will first need to create one before proceeding with the aforementioned steps.

After signing into your Zoom account, you will be redirected to Framework and the integration will be complete.

Usage

To use the Zoom integration, navigate to the Events tab in your community’s Administrator View. Click + Create to create a new event, fill out the form, and click Create Zoom Meeting to generate a unique Zoom link for your meeting. After clicking + Create, your new event with a unique Zoom link will be visible to you and your members in the Events page in the Member View.

Uninstallation

To uninstall Zoom in your community, navigate to the Integrations page in your community’s Administrator View. Click Disconnect to disconnect your Zoom account. To fully revoke Framework's access to Zoom, log into your Zoom account and navigate to the Zoom App Marketplace. Click Manage > Installed Apps or search for the Framework ****app. Click the Framework app and click Uninstall.

Add-Ons > Connect

If you have a CRM you would like to connect to Framework, you can set that up through our new Zapier integration! Send inputs like member email addresses, names, and joining dates to the likes of Active Campaign, Airtable, or any other CRM tool you use.

3. Framework API

Finally, for use cases not covered by Zapier or Third Party Integrations, Framework provides an API.

The most common use case of our API is assigning product access to a member (via email address), without that member needing to a purchase the product through Framework. For information on additional use cases, please contact us.

Installation
For members on our Enterprise plan, navigate to Admin > Settings > API Keys and create a new API key.

Note: Framework API keys are currently only available through our Enterprise plan.

Usage

• Once you have created a key, send a POST request to https://us-central1-upliftnowapp.cloudfunctions.net/apiConnector/v1/grantProduct with the following JSON payload:

{
    "email": "<USER_EMAIL>",
    "productId": "<PRODUCT_ID>"
}

• Relevant product ID can be obtained under Admin > Payments page
• For authorization, provide your API key as a Bearer token:
• Set an Authentication header on the request to Bearer <YOUR_API_KEY>
• Set a Content-Type header on the request to application/json

Remember, this works for both existing and non-existing members.

• If you call this endpoint for an existing member, they will immediately be granted the requested product.
• If you call the endpoint with an email that does not currently exist in Framework, the user will be automatically issued the product upon account creation for the specified email only.

For any questions or additional information, please contact us.