Changelog

Keep track of every change to the Server API.

This changelog lists all additions and updates to the Server API released after October 1st, 2022, in reverse chronological order.

2022-12-07

2022-11-29

  • Add appointment_type_id to /appointments and /web_call_invitations.
  • Add appointment_category_id to /web_call_invitations.

2022-11-25

2022-11-18

  • Add Task endpoints.
  • Add new types of webhook events task.created, task.updated and task.deleted.
  • Add isPatientTask field on task which allows tasks to be assigned to the patient instead of the provider. A patient task can't have a provider assigned to it.

2022-11-15

  • In the Patient object, add an optional summary
  • Add new types of webhook events conversation.locked and conversation.unlocked. They are sent when a conversation is locked/unlocked.
  • Add locked field on conversation which describes whether a conversation is locked or not. A locked conversation can't receive new messages from the patient, providers, nor the system. (2022-10-19 only)

2022-11-04

  • Fix API calls that didn't use correctly the default pinned version.
  • In the Patient object, group all the address fields in a same object

2022-11-02

2022-10-31

  • Create version 2022-10-19 for conversation (see upgrades)
    • In the conversation object:
      • the patient field is deprecated and replaced by patients, which contains the list of patients included in the conversation
    • In Create a conversation, in body params:
      • patient_id is deprecated and replaced by patient_ids, which contains the list of patients included in the conversation.
      • A new field is required, type, to categorize the conversation with 2 possible values:
        • individual_conversation, when there's a single patient with one or several practitioners
        • group_conversation for conversation with several patients.
    • In Update a conversation, in body params:
      • a new field can be used in the params: patient_ids, if you want to add new patients in a "group conversation"

2022-10-26

2022-10-24

2022-10-20

2022-10-11

2022-10-06

  • Add Authentication endpoints that provide JWT tokens to log in a user.