An interface for inter-app user communication about an appointment. Initial use cases include direct messaging and post-showing feedback.

Last update 26-Jul DR

Status: STABLE

Routes:

POST /appointments/{appointmentId}/sendMessage
GET  /appointments/{appointmentId}/messages

Usage Notes

This is an extremely lightweight way of implementing inter-agent messaging about an established appointment. We imagine the 80% use case for this is the ever-popular "Hey we're running 15 minutes late" message.

Messages will be delivered via webhook with the webhookMessageType value "MessageCreated", and therefore will be available via the webhookMessages interface, if you need to recover any you missed.

messageFromName

We know the agent's names on both sides of an appointment from the data we collected on the Registration and the Appointment Request. Those will be shown as the "from" of messages related to this Appointment unless you provide a messageFromName string to override that.