Skip to main content

Practice Management on Embodia - Part 2: Scheduling

The actions described in this lesson require a Manager permission on your clinic.

Nerd alert: This guide will include some technical jargon:

  • POST request: is a type of web request
  • JSON: short for JavaScript Object Notation, is a standardized way data can be shared between 2 applications

A webhook is one of the ways two applications can communicate with each other. If you use another application that can listen to webhooks, you can configure your Embodia account to send a webhook with the relevant information when a certain event happens on Embodia. For example, if you use Zapier, you can use the Webhooks by Zapier Integrations to pair your Embodia account with the multitude of applications that connect to Zapier.

If you would like to learn more about what webhooks are, Zapier has a great article that explains webhooks in further details.


To get started, navigate to Consults > Export > Webhooks:

Webhooks on Embodia


On the webhooks page, you will see all the events that can trigger a webhook on Embodia. At this time, we only support sending a webhook when a consult is scheduled, updated, or cancelled. If you would like to receive webhooks for other events, please reach out to us at support@embodiaapp.com.

To configure your webhook parameters, click on Configure. In the pop-up form:

  • Enter the URL: this is the URL address where Embodia will send a POST request with the relevant information.
  • Select which events should trigger sending the webhook request to the specified URL
  • Select which data (in JSON format) to include in the webhook request

 

Sending a webhook when a consult is scheduled, updated, or cancelled

Depending on your configuration, Embodia will send a webhook for the following events:

  • Consult is scheduled: The webhook will be triggered when a new consult is created for a patient, or when a patient is added to an existing group consult/class. The JSON data sent to the specified URL will include an "event" key with the value of "participant.added" (more info below).
  • Consult is updated: The webhook will be triggered when a consult is updated (such as the start time, or duration). The JSON data sent to the specified URL will include an "event" key with the value of "consult.updated" (more info below).
  • Consult is cancelled: The webhook will be triggered when a consult is cancelled, or when a patient is removed from a group consult/class. The JSON data sent to the specified URL will include an "event" key with the value of "participant.removed" (more info below).

The JSON data sent in the request will be an array with one or more of the following JSON objects:

{
  event: String - can have one of the following values: "participant.added", "consult.updated", "participant.removed",
  consult: {
    id: Integer - unique ID of the consult on Embodia,
    start_time: Time - the start time of the consult,
    end_time: Time - the end time of the consult,
    duration: Number - the consult duration in minutes,
    cancelled: Boolean - indicates if the consult has been cancelled,
  },
  service: {
    id: Integer - unique ID of the service on Embodia,
    name: String - the name of the service,
  },
  practitioner: {
    id: Integer - unique ID of the practitioner account on Embodia,
    name: String - the name of the practitioner,
    email: String - the email of the practitioner,
  },
  participant: {
    id: Integer - unique ID of the patient account on Embodia,
    name: String - the name of the patient,
    email: String | Null - the email of the patient if it has been provided,
  },
}

Please note that the "practitioner" and "participant" information will only be included in the JSON data if the configuration of the webhook was set to include the practitioner and patient information, respectively.

Back
© 2024 Embodia