Overview

Introduction

Flow overview

Requirements

Versionning

Authentication

Server authentication

Incoming APIs

Overview

Provision user

Create encounter

Refresh encounter URL

Outgoing APIs

Overview

Callback authentication

Response protocol

Callback types

Reference

Changelog

All Nabla callbacks share the same base envelope. The type field determines the payload shape.

Base request shape

{
  "request_uuid": string,
  "type": "NOTE_EXPORT | PATIENT_INSTRUCTIONS_EXPORT | ...",
  ...
}

Expected responses

For every 200 response, echo back the request_uuid in the body:

{ "request_uuid": string }

⚠️ Respond quickly — Nabla awaits your response before showing a success message in the app. Slow or failed responses will surface an error to the provider.