Registered Chats

A registered chat is the mechanism by which an external system informs MedChat of a future chat and securely passes chat properties for that chat ahead of time.

The external system registers a chat by calling an endpoint on the MedChat API. The MedChat API saves the registered chat and any associated chat properties. The MedChat API then returns to the caller a reference code that can be used to build a chat invite URL to the registered chat.

📘

Pass data securely

Registered chats are a secure method for priming a chat with confidential patient data, since chats are registered via an authenticated server-to-server API call. Any data passed from the source system when registering a chat will be available as chat properties to the chatbot when the patient starts the chat.

🚧

Registered chats are one-time use

Once a chat has been started from a registered chat, that registered chat reference code cannot be used to start another chat.

See the related guides for details on how to incorporate registered chats into your organization's workflow.