Skip to main content

Spruce Integration

Pipe Spruce conversations and attachments into XY so patient messages turn into next steps automatically.

Overview​

The Spruce integration connects XY to your Spruce patient communication platform, enabling workflows and agents to access patient conversations, messages, and attachments. This integration transforms patient communications into actionable workflow steps.

Authentication & Setup​

  1. Navigate to the Integrations section in the XY Web App
  2. Select Spruce from the integration directory
  3. Click "Connect" and complete the Spruce OAuth authentication flow
  4. Grant XY the necessary permissions to access your Spruce account
  5. Configure which conversations and message types XY should monitor

Post-Authentication Configuration​

After connecting, configure:

  • Conversation Filters: Select which types of conversations XY should monitor
  • Message Filters: Optionally filter messages by keywords, patient, or message type
  • Sync Frequency: Set how often XY should check for new messages
  • Attachment Handling: Configure how attachments should be processed

Endpoints & Capabilities​

Read Operations​

  • List Conversations: Retrieve patient conversation threads
  • Get Conversation: Fetch full conversation details and history
  • Get Messages: Retrieve messages from specific conversations
  • Get Attachments: Download message attachments
  • Search Conversations: Query conversations by patient, date, or keywords
  • Get Patient Information: Retrieve patient details from Spruce

Write Operations​

  • Send Message: Send messages to patients via Spruce
  • Reply to Message: Send replies to existing conversation threads
  • Update Conversation Status: Mark conversations as read, resolved, or archived
  • Upload Attachment: Share files with patients through Spruce

Configuration​

  • Set Sync Frequency: Configure how often to check for new messages
  • Manage Conversation Filters: Add or remove conversation types from monitoring
  • Configure Message Filters: Set up filtering rules for message processing
  • Attachment Settings: Configure attachment download and processing options

Use Cases​

  • Patient Message Processing: Automatically process patient messages and route to appropriate workflows
  • Automated Responses: Send automated replies to common patient inquiries
  • Document Collection: Extract attachments from patient messages for processing
  • Workflow Triggers: Trigger workflows based on patient message content or keywords
  • Patient Communication Automation: Automate follow-up communications and reminders