Freshpaint integration

Freshpaint is a HIPAA-compliant customer data platform (CDP) that allows you to unify and standardize customer data across all your analytics and marketing tools. You can pass events and user traits to Freshpaint from Capable Health to other destinations, such as analytics providers and messaging engagement platforms. Capable offers an integration with Freshpaint. (Please note that Capable also offers an integration with Segment, another CDP.) Below, we walk through how to set up the Freshpaint integration and explain a few key points to keep in mind when using it.

Please also see our article about identity and tracking user journeys for relevant information about using downstream platforms with Capable.

Think about downstream destinations

Before setting up a Freshpaint account, think about which downstream destinations you want to use. You can add new destinations at any time after creating your Freshpaint account. Here are some common destination types:

  • 📊 Analytics: Platforms for analyzing your customers’ journey through your application. Example providers include Amplitude, Mixpanel, and Google Analytics.
  • 💬 Communications: Platforms for sending communications to your customers based on events in your app, such as the purchase of a product or completion of a questionnaire. Example providers include Braze, Iterable, and Klaviyo.
  • ⏯️ Session Replay: Platforms for viewing user sessions and heatmaps. Example providers include Fullstory, Crazy Egg, and Replay Bird.

One factor to keep in mind when choosing downstream platforms is the particular HIPAA rules your application may need to follow. Not every platform signs Business Associate Agreements (BAA).

How to set up the integration

First, you’ll need to set up a Freshpaint account. We strongly recommend setting up a sandbox environment in Freshpaint for testing purposes in addition to a production environment.

After you have an account, you’ll need to retrieve the client token from your Freshpaint admin portal. In the portal, go to the “Events” page in the “Sources” section on the lefthand navigation bar. Find “Server-side” on the list and click “Configure” — copy the UUID found there.

Retrieving your Freshpaint tokenRetrieving your Freshpaint token

Retrieving your Freshpaint token

Next, go to your Capable admin portal, to the “Integrations” section, and select the Freshpaint integration. Enter the client token.

If you have sandbox and production environments in Freshpaint, you’ll need to duplicate this process for each environment.

Once you’ve completed this process, events from Capable should begin flowing to Freshpaint! You can verify that the integration is working by using Freshpaint’s “Live View” and triggering events in Capable by calling the relevant API endpoints.

Event data sent by Capable

Please see our documentation page about events for details on the specific data sent to Freshpaint from Capable Health.

In addition to the event data, Capable sends the following user characteristics to Freshpaint every time a Patient Create or Patient Update event occurs:

  • name
  • email
  • phone

You can manually add other user traits to this “identify” data in your frontend using Freshpaint’s SDKs.

Add downstream destinations in Freshpaint

After you’ve selected and signed up for accounts with downstream platforms, you can add them to your Freshpaint account. In your Freshpaint admin account, go to the “Apps” page in the “Destinations” section to configure each of the integrations. You’ll need to enter your API credentials for each one.

You can then test each platform to make sure events are flowing as expected.

Customize HIPAA Rules

Because Freshpaint is HIPAA-compliant, it restricts Protected Health Information (PHI) in downstream platforms by default. This means that all data will be masked or not sent at all to downstream platforms unless you add them to the HIPAA Allow List in the Freshpaint portal. Properties permitted in your HIPAA Allow List will be accessible to all of your destinations.

You can override the HIPAA Allow List setting for each destination by navigating to the “Apps” page in the “Destinations” section in your Freshpaint admin portal. Click “Configure” on the relevant destination and you should see “HIPAA Settings” — click “Configure” again to change them.

When this option is checked, data will be sent to the destination without applying Freshpaint's safeguards for PHI such as ID masking and enforced allowlists. You should only disable these features if you have a BAA in place with the destination, or if you have determined you are not sending PHI.

Check out other Freshpaint features

Freshpaint offers other functionality you may want to use:

  • Track frontend events: You can track frontend events in your app, such as user clicks on specific resources, using Freshpaint.
  • Set up a data warehouse: You can set up a data warehouse integration with Freshpaint to store event data for analytics purposes.

Did this page help you?