Embeddable widgets for website integration (technical documentation)

Modified on Tue, 17 Nov at 10:03 AM

About this article

This article is intended for technical teams responsible for website integrations and software development.


MAGICapp provides embeddable web components that allow third-party websites to display clinical guideline content and enable authenticated API access. This article provides an overview of the available widgets and links to widget-specific technical documentation.


Looking for general information about sharing MAGICapp content? See:


Looking for direct API access?

Widgets are one approach to integrating MAGICapp content into external systems. If you need direct access to MAGICapp data through API requests, including API user accounts, permissions management, authentication, or access to non-public content, see API: Using the MAGICapp API (technical documentation).


MAGICapp Web Components 

MAGICapp provides embeddable web components that allow third-party websites to display clinical guideline content and enable authenticated API access. These components are production-ready widgets that can be easily integrated into any web application.


Available Components 

<magicapp-connect> 

An authentication and API component that handles OAuth 2.0 login flow with MAGICapp's API. Third-party applications use this component to:

  • Authenticate users via Keycloak
  • Obtain access tokens for API calls
  • Automatically manage token refresh
  • Provide access to the APIBuilder for making authenticated API calls
  • Enable authenticated requests from other components on the page

For more information see: Website widget authentication: magicapp-connect (technical documentation)


The APIBuilder is lazy-loaded on first use, providing a fluent interface for accessing MAGICapp's API endpoints without requiring manual token management.


Use Case: Required for any third-party application that needs to make authenticated API calls to MAGICapp. Can also be used standalone to provide programmatic API access.

For more information see: Programmatic API access for widgets: API Builder (technical documentation)


<magicapp-recommendation>

Displays a complete clinical recommendation with all associated content (key information, rationale, evidence summaries, decision aids, etc.). This component uses the same code as the MAGICapp UI - the web component is simply a wrapper around the production interface.


Use Case: Embed individual clinical recommendations on external websites, EHR systems, or clinical decision support tools.

For more information see: Embeddable recommendation widget: magicapp-recommendation (technical documentation)


<magicapp-pico> 

Displays PICO (Population, Intervention, Comparison, Outcome) information for clinical questions. Like the recommendation component, this uses production UI code wrapped in a web component.


Use Case: Display structured clinical question information on external platforms.

For more information see: Embeddable PICO widget: magicapp-pico (technical documentation)


How it works 

Authenticated Components: The magicapp-recommendation and magicapp-pico components can be on the same page as magicapp-connect to automatically use OAuth authentication for API calls. When used standalone, they make unauthenticated (public) API requests.


Integration Steps:

  1. Include the component script(s) in your page's <head> section
  2. Add the component tag(s) in your HTML markup where you want the widget to appear
  3. Configure the component using HTML attributes or JavaScript properties
  4. (Optional) Listen for component events to respond to user interactions


Code Reuse: The recommendation and PICO widgets leverage the same battle-tested code that powers the MAGICapp production interface, ensuring consistency and reliability.


Examples and Demos 


If you have any queries about our widgets, please contact support@magicevidence.org


Last updated: 17 November 2026

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article