Skip to main content

Spruce Public API

Updated

About the API

The Spruce Health Public API allows you to connect the Spruce platform to any other tools that are open for integration. You will need some Engineering or Development resources on your team to take advantage of this and if you are a Spruce customer, you must be on the Communicator plan to use the API. Here are some use cases currently supported by the Spruce API:

  1. Automatically create and sync contacts in Spruce with contacts/charts in other systems.
  2. Update patient contact information and vital details in both systems.
  3. Trigger a message (SMS or secure) in Spruce based on an event in your system. (e.g., appointment reminders, follow-up messages, new patient welcome information)
  4. Sync conversation events from Spruce to another platform. (e.g. push Spruce messages into the corresponding patient chart in your EHR)
  5. Create a flow where you can one-click open Spruce from an external system and / or open an external system from Spruce.

You can read all about the API and its functionality on the developer documentation page here. 

How to get access to the API

If you are interested in using the Spruce API, here are the steps to get started:

  1. Create a separate Spruce organization for testing purposes. To do this, click here or log out of your current Spruce account, and create a new organization.
  2. Send us a message in the "Team Spruce" conversation in the new organization you've just created letting us know this is a test organization for use with the Spruce API.
  3. We will mark that organization as a test org and enable the API so you can start building and testing anything you want.
  4. Once you've completed your testing, have an admin from your main Spruce organization message us in the "Team Spruce" conversation requesting that we enable the API for your organization. 
  5. Once the API is enabled, you can generate tokens from your Spruce settings, under "Integrations & API."

Testing SMS Messaging

Please note that if you are testing SMS messaging via the API, outgoing SMS messages will not be delivered because the account is unregistered. However, registration is not needed for API test accounts. If you attempt to send an SMS, you will receive an error indicating the account is unregistered, but the error will only appear if the message attempt is made, allowing you to still test outgoing SMS functionality.

If you need any help with this process, just message Team Spruce in your app and we'll be happy to help! You can also email our sales team at sales@sprucehealth.com if you have questions about how Spruce works with different healthcare practices.

**If you are interested in connecting Spruce to one of your tools but don't have the Engineering or Development resources to leverage the API yourself, we recommend you try out Keragon! You can read more about it here.

 

Related articles