Overview

Introduction

Flow overview

Requirements

Versioning

Authentication

Server authentication

Incoming APIs

Overview

Provision user

Create encounter

Refresh encounter URL

Manage user status

Outgoing APIs

Overview

Callback authentication

Response protocol

Callback types

Reference

Changelog

What you need to build

On your side, integrating with Nabla Connect requires the following.

Incoming API support (EHR → Nabla)

You need to call Nabla APIs to launch encounters. This requires:

• Setting up an OAuth client so that you can authenticate your calls to Nabla (see Server authentication)
• Creating a button on the encounter screen in your EHR and linking it to sending a POST /encounter request from your backend

Iframe usage

If you are embedding the Nabla app in an iframe, you must add the following permissions:

• microphone (required) to allow microphone access
• clipboard-write (required) to allow clipboard access for the copy buttons to work
• loopback-network (optional) to allow local network access if you are planning to use Nabla Echo for audio capture

<iframe src="connect.nabla.com/..." allow="microphone;"/>

Outgoing API support (Nabla → EHR)

You need to receive callbacks from Nabla. This requires:

• Exposing a catch-all endpoint and providing Nabla with its URL (configured on the Nabla Connect Admin page)
• Setting up the HMAC auth mechanism so that you can verify requests are genuinely from Nabla (see Webhook authentication (HMAC))
• Binding callbacks to actions on your side — typically, storing the note content and adding it to the current draft in your EHR