Canvas Medical EMR Customization - SDK, FHIR API & Guides
API SDK Guides Product Updates
  • SDK Overview
    • Introduction
    • Caching Module
    • Clients Module
      • AWS S3
      • Canvas FHIR
      • Extend AI
      • LLMs
      • SendGrid
      • Twilio
    • Command Line Interface
    • Commands Module
      • Custom Command
    • Custom Data
      • Quick Start
      • Extending SDK Models
      • CustomModels
      • AttributeHubs
      • Transactions
      • Design Considerations
      • Testing
      • Namespace Lifecycle
      • Sharing Data
    • Data Module
      • AllergyIntolerance
      • Application
      • Appointment
      • Assessment
      • BannerAlert
      • BillingLineItem
      • BusinessLine
      • Calendar
      • CancelPrescription
      • CancelPrescriptionResponse
      • CanvasUser
      • CareTeam
      • Change Medication
      • ChargeDescriptionMaster
      • ChartSectionReview
      • Claim
      • Command
      • CommonEnumerationTypes
      • CompoundMedication
      • Condition
      • ContentType
      • Coverage
      • DetectedIssue
      • Device
      • DiagnosticView
      • DocumentReference
      • DocumentReviewDelegation
      • EducationalMaterial
      • EligibilityResponse
      • EligibilitySummary
      • Encounter
      • ExternalEvent
      • Facility
      • FamilyHistory
      • FollowUp
      • Goal
      • HistoryOfPresentIllness
      • Imaging
      • ImagingReportTemplate
      • Immunization
      • Instruction
      • IntegrationTask
      • Invoice
      • LabPartner
      • LabReportTemplate
      • Labs
      • Letter
      • LetterActionEvent
      • Medication
      • Medication History
      • Medication Statement
      • Message
      • Note
      • Observation
      • Organization
      • OrganizationalEntity
      • Patient
      • PatientAdministrativeDocument
      • PatientConsent
      • PatientGroup
      • PayorSpecificCharge
      • Plan
      • PluginCommand
      • Posting
      • PracticeLocation
      • Prescription
      • PrescriptionChangeRequest
      • PrescriptionChangeResponse
      • Procedure
      • ProtocolCurrent
      • ProtocolOverride
      • Questionnaire
      • ReasonForVisit
      • Referral
      • RefillRequest
      • RemoveAllergyEvent
      • ResolveConditionEvent
      • ServiceProvider
      • Snapshot
      • SpecialtyReportTemplate
      • Staff
      • Stop Medication Event
      • Task
      • Team
      • Uncategorized Clinical Documents
      • Vaccine
      • ValueSets
      • VisualExamFinding
      • VitalSignReading
    • Effects Module
      • Appointment Labels
      • Appointment Metadata
      • Appointment Metadata Create Form
      • Appointments
      • Application Notification Badge
      • Banner Alerts
      • Batch Originate Commands
      • Billing Line Items
      • C-CDA Export
      • Claims
      • Command Metadata
      • Configure Command Buttons
      • Command Metadata Create form
      • Command Validation
      • Compound Medications
      • Create Calendar
      • Create Patient Preferred Pharmacies
      • Custom HTML and Django Templates
      • Data Integration
      • Default Homepage
      • Event Validation Error
      • External Events
      • HTTP Request
      • Lab Report
      • Layout Effects
      • Manage Calendar Events
      • Messages
      • Note Footer Configuration
      • Note Metadata
      • Note Restrictions
      • Notes
      • Observations
      • Patient
      • Patient Chart Group
      • Patient Chart Summary Custom Section
      • Patient External ID
      • Patient Facility Address
      • Patient Group
      • Patient Metadata
      • Patient Metadata Create Form
      • Patient Portal
      • Patient Timeline
      • Payment Processor
      • Protocol Cards
      • Questionnaires
      • Redirect
      • Reload Action Buttons
      • Send Contact Verification
      • ServiceProvider
      • Staff External ID
      • Staff Metadata
      • Surescripts
      • Task Metadata
      • Tasks
    • Events Module
    • Handlers Module
      • Action Buttons
      • Applications
      • BaseHandler
      • CronTask
      • Embedded Applications
        • Note Applications
        • Scheduling Applications
        • Docked Applications
      • Patient Chart Summary Custom Section
      • Payment Processors
    • Logging
    • Protocols Module
    • Provider Companion
    • Questionnaires
    • Sandboxing and Allowed Imports
    • Variables
    • SimpleAPI
      • HTTP API
      • WebSocket API
      • Commands API
    • SSO Capabilities
    • Testing Utilities
    • Utils Module
  • Example Plugins
    • API Samples
    • Charting Interface
      • Abnormal Lab Task Notification
      • AI Note Titles
      • Charting API Examples
      • Example Chart Application
      • Extend AI PDF
      • Group Items in Patient Chart
      • Patient Creation Platform Sync
      • PayTheory Payment Processor
      • Send All Prescriptions
      • Upsert Patient Metadata
      • Vitals Visualizer
    • Patient Portal Customization
      • Customize with Widgets
      • Launch an Application
    • Integrations
      • AWS S3
      • LLM
      • SendGrid Email
      • Twilio SMS/MMS

SimpleAPI

Last updated: 28 Aug 2026

The Canvas SDK allows developers to define both HTTP and WebSocket APIs to integrate custom plugin logic into a Canvas instance.

HTTP API

Define endpoints to handle incoming HTTP requests using custom logic and authentication.

WebSocket API

Establish real-time communication channels for interactive plugin behavior and updates.

Commands API

Expose commands as HTTP endpoints, validated against the command itself.

Questions? Create an issue.

Useful guides

Writing Commands Over HTTP

© Canvas Medical