Skip to main content

Spruce API

Updated

Spruce API Overview

The Spruce API enables you to integrate the Spruce platform with your internal tools, electronic health records (EHRs), or other external systems. This allows your organization to automate workflows, sync data seamlessly, and extend Spruce’s functionality to better fit your operations.

⚠️ To use the Spruce API, you must be on the Communicator plan, and you’ll need support from Engineering or Development resources on your team.

In addition to standard RESTful endpoints, the API includes support for webhooks, enabling real-time event notifications—for example, to automatically trigger actions in your systems based on events happening in Spruce.

Common Use Cases

With the Spruce API and webhooks, you can:

  • Sync Contacts & Charts: Automatically create and update contacts in Spruce based on external systems (e.g., syncing with your EHR or CRM).

  • Maintain Accurate Records: Ensure patient contact info and key demographics stay updated across systems.

  • Trigger Messages Automatically: Send secure messages or SMS from Spruce when specific events occur in your systems—like appointment reminders, follow-ups, or onboarding sequences.

  • Streamline Documentation: Push Spruce conversation data into other systems (e.g., update a patient’s chart in your EHR with relevant messages or notes).

  • Enable Deep Linking: Launch Spruce from within another system, or vice versa, for seamless navigation and workflow integration.

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