Overview

Introduction

Flow overview

Requirements

Versionning

Authentication

Server authentication

Incoming APIs

Overview

Provision user

Create encounter

Refresh encounter URL

Outgoing APIs

Overview

Callback authentication (HMAC)

Response protocol

Callback types

Reference

Changelog

This endpoint should be called by your backend when you need a fresh URL for an existing encounter.

Method: POST

Path: <baseUrl>/encounters/url

POST /encounter/url is a deprecated alias with the same behavior.

Nabla will match the user corresponding to your provider and the encounter, and return a one-time URL your frontend should navigate to.

Navigating to this URL will log in the provider into Nabla automatically and open the app on this encounter.

⚠️ The URL can only be used once and expires in 10 minutes. The URL must not be stored.

Request payload

{
  "external_provider_id": string,
  "external_encounter_id": string
}

Response

{ "encounter_url": string }