{
  "application": "HEALTHIE",
  "appointment_type": {
    "id": null,
    "length_minutes": null,
    "name": null
  },
  "end_date": "2025-01-07",
  "event_data": {
    "referrer_domain": "example.com",
    "referrer_url": "https://example.com/schedule-appointment"
  },
  "hours_until_next_available_timeslot": 24,
  "insurance_payer": {
    "geographically_scoped_insurance_payer": {
      "geographic_locale": null,
      "insurance_payer": {
        "ehr_id": null,
        "id": null,
        "name": null
      }
    },
    "insurance_payer": {
      "ehr_id": null,
      "id": null,
      "name": null
    }
  },
  "internal_tags": [
    "high_priority",
    "new_patient"
  ],
  "licensed_geographic_locales": [
    "CA",
    "NY"
  ],
  "num_timeslots_in_range": 42,
  "num_timeslots_on_viewed_date": 7,
  "profile_customer_id": "02afaa5f-9f26-43dc-a1f8-92d3d4f7a097",
  "profile_email_address": "joe@bloggs.com",
  "providers_viewed": [
    {
      "name": "Dr. Jane Smith",
      "provider_id": {
        "id": null,
        "id_type": null
      }
    }
  ],
  "specialties": [
    "Cardiology",
    "Pediatrics"
  ],
  "start_date": "2025-01-01",
  "view_type": "BASIC_VIEW",
  "viewed_date": "2025-01-03"
}

{
  "application": "The scheduling application being used",
  "appointment_type": {
    "id": null,
    "length_minutes": null,
    "name": null
  },
  "end_date": "End date of the viewed calendar range",
  "event_data": "(Optional) Data associated with the event, *not* automatically stored on the Morf Profile",
  "hours_until_next_available_timeslot": "Hours until the next available timeslot in the calendar date-range",
  "insurance_payer": {
    "geographically_scoped_insurance_payer": {
      "geographic_locale": null,
      "insurance_payer": {
        "ehr_id": null,
        "id": null,
        "name": null
      }
    },
    "insurance_payer": {
      "ehr_id": null,
      "id": null,
      "name": null
    }
  },
  "internal_tags": "Internal tags associated with the timeslot selection",
  "licensed_geographic_locales": "List of US state codes where the provider is licensed",
  "num_timeslots_in_range": "Number of available timeslots in the viewed date range",
  "num_timeslots_on_viewed_date": "Number of available timeslots on the viewed date",
  "profile_customer_id": "The customer ID sent to the scheduling application from the form for the person viewing the scheduling availability, e.g. the Formsort responder_uuid or Feathery user_id",
  "profile_email_address": "The email address sent to the scheduling application for the person viewing the scheduling availability",
  "providers_viewed": {
    "name": "The name of the provider",
    "provider_id": {
      "id": null,
      "id_type": null
    }
  },
  "specialties": "List of provider specialties",
  "start_date": "Start date of the viewed calendar range",
  "view_type": "The type of view being used",
  "viewed_date": "The date the user clicked on to see available time slots"
}

Events

Triggering Webhook Types

The following event types are associated with the Time Slot Selection Viewed event payload from Morf.

Time Slot Selection Viewed

{
  "application": "HEALTHIE",
  "appointment_type": {
    "id": null,
    "length_minutes": null,
    "name": null
  },
  "end_date": "2025-01-07",
  "event_data": {
    "referrer_domain": "example.com",
    "referrer_url": "https://example.com/schedule-appointment"
  },
  "hours_until_next_available_timeslot": 24,
  "insurance_payer": {
    "geographically_scoped_insurance_payer": {
      "geographic_locale": null,
      "insurance_payer": {
        "ehr_id": null,
        "id": null,
        "name": null
      }
    },
    "insurance_payer": {
      "ehr_id": null,
      "id": null,
      "name": null
    }
  },
  "internal_tags": [
    "high_priority",
    "new_patient"
  ],
  "licensed_geographic_locales": [
    "CA",
    "NY"
  ],
  "num_timeslots_in_range": 42,
  "num_timeslots_on_viewed_date": 7,
  "profile_customer_id": "02afaa5f-9f26-43dc-a1f8-92d3d4f7a097",
  "profile_email_address": "joe@bloggs.com",
  "providers_viewed": [
    {
      "name": "Dr. Jane Smith",
      "provider_id": {
        "id": null,
        "id_type": null
      }
    }
  ],
  "specialties": [
    "Cardiology",
    "Pediatrics"
  ],
  "start_date": "2025-01-01",
  "view_type": "BASIC_VIEW",
  "viewed_date": "2025-01-03"
}

{
  "application": "The scheduling application being used",
  "appointment_type": {
    "id": null,
    "length_minutes": null,
    "name": null
  },
  "end_date": "End date of the viewed calendar range",
  "event_data": "(Optional) Data associated with the event, *not* automatically stored on the Morf Profile",
  "hours_until_next_available_timeslot": "Hours until the next available timeslot in the calendar date-range",
  "insurance_payer": {
    "geographically_scoped_insurance_payer": {
      "geographic_locale": null,
      "insurance_payer": {
        "ehr_id": null,
        "id": null,
        "name": null
      }
    },
    "insurance_payer": {
      "ehr_id": null,
      "id": null,
      "name": null
    }
  },
  "internal_tags": "Internal tags associated with the timeslot selection",
  "licensed_geographic_locales": "List of US state codes where the provider is licensed",
  "num_timeslots_in_range": "Number of available timeslots in the viewed date range",
  "num_timeslots_on_viewed_date": "Number of available timeslots on the viewed date",
  "profile_customer_id": "The customer ID sent to the scheduling application from the form for the person viewing the scheduling availability, e.g. the Formsort responder_uuid or Feathery user_id",
  "profile_email_address": "The email address sent to the scheduling application for the person viewing the scheduling availability",
  "providers_viewed": {
    "name": "The name of the provider",
    "provider_id": {
      "id": null,
      "id_type": null
    }
  },
  "specialties": "List of provider specialties",
  "start_date": "Start date of the viewed calendar range",
  "view_type": "The type of view being used",
  "viewed_date": "The date the user clicked on to see available time slots"
}

Payload Field Details

Event Payload

Hide fields

scheduling.v1.SchedulingApplication

required

The scheduling application being used

CEL

application

Example

scheduling.v1.SchedulingApplication.HEALTHIE
scheduling.v1.SchedulingApplication.ACUITY

scheduling.v1.SchedulingApplicationViewType

required

The type of view being used

CEL

view_type

Example

scheduling.v1.SchedulingApplicationViewType.BASIC_VIEW
scheduling.v1.SchedulingApplicationViewType.PROVIDERS_VIEW
scheduling.v1.SchedulingApplicationViewType.PROVIDER_PROFILE

object

required

Appointment type information, the ID, name (title), and default length in minutes

CEL

appointment_type

Example

{
"id": null,
"length_minutes": null,
"name": null
}

string

required

Description coming soon

CEL

appointment_type.id

Example

null

string

required

Description coming soon

CEL

appointment_type.name

Example

null

uint64

required

Description coming soon

CEL

appointment_type.length_minutes

Example

null

[]string

required

List of US state codes where the provider is licensed

CEL

licensed_geographic_locales

Example

[
"CA",
"NY"
]

[]string

required

List of provider specialties

CEL

specialties

Example

[
"Cardiology",
"Pediatrics"
]

[]string

required

Internal tags associated with the timeslot selection

CEL

internal_tags

Example

[
"high_priority",
"new_patient"
]

values.v1.Date

required

Start date of the viewed calendar range

CEL

start_date

Example

"2025-01-01"

values.v1.Date

required

End date of the viewed calendar range

CEL

end_date

Example

"2025-01-07"

values.v1.Date

required

The date the user clicked on to see available time slots

CEL

viewed_date

Example

"2025-01-03"

uint64

required

Number of available timeslots on the viewed date

CEL

num_timeslots_on_viewed_date

Example

uint64

required

Number of available timeslots in the viewed date range

CEL

num_timeslots_in_range

Example

uint64

required

Hours until the next available timeslot in the calendar date-range

CEL

hours_until_next_available_timeslot

Example

[]object

required

List of providers whose schedules were viewed

CEL

providers_viewed

Example

[
{
"name": "Dr. Jane Smith",
"provider_id": {
"id": null,
"id_type": null
}
}
]

[]bool

required

Mapped array of: The unique identifier of the provider for the scheduling application

CEL

providers_viewed.map(x, x.provider_id)

Example

[
{
"id": null,
"id_type": null
}
]

scheduling.v1.SchedulingApplication

required

Mapped array of: The unique identifier of the provider for the scheduling application

CEL

provider_id.id_type

Example

scheduling.v1.SchedulingApplication.HEALTHIE
scheduling.v1.SchedulingApplication.ACUITY

[]string

required

Mapped array of: The name of the provider

CEL

providers_viewed.map(x, x.name)

Example

[
"Dr. Jane Smith"
]

string

The customer ID sent to the scheduling application from the form for the person viewing the scheduling availability, e.g. the Formsort responder_uuid or Feathery user_id

CEL

profile_customer_id

Example

"02afaa5f-9f26-43dc-a1f8-92d3d4f7a097"

object

Insurance payer used in filtering availability (optional)

CEL

insurance_payer

Example

{
"geographically_scoped_insurance_payer": {
"geographic_locale": null,
"insurance_payer": {
"ehr_id": null,
"id": null,
"name": null
}
},
"insurance_payer": {
"ehr_id": null,
"id": null,
"name": null
}
}

object

Description coming soon

CEL

insurance_payer.insurance_payer

Example

{
"ehr_id": null,
"id": null,
"name": null
}

string

Description coming soon

CEL

insurance_payer.insurance_payer.id

Example

null

string

Description coming soon

CEL

insurance_payer.insurance_payer.name

Example

null

string

Description coming soon

CEL

insurance_payer.insurance_payer.ehr_id

Example

null

object

Description coming soon

CEL

insurance_payer.geographically_scoped_insurance_payer

Example

{
"geographic_locale": null,
"insurance_payer": {
"ehr_id": null,
"id": null,
"name": null
}
}

object

Description coming soon

CEL

insurance_payer.geographically_scoped_insurance_payer.insurance_payer

Example

{
"ehr_id": null,
"id": null,
"name": null
}

string

Description coming soon

CEL

insurance_payer.geographically_scoped_insurance_payer.insurance_payer.id

Example

null

string

Description coming soon

CEL

insurance_payer.geographically_scoped_insurance_payer.insurance_payer.name

Example

null

string

Description coming soon

CEL

insurance_payer.geographically_scoped_insurance_payer.insurance_payer.ehr_id

Example

null

string

Description coming soon

CEL

insurance_payer.geographically_scoped_insurance_payer.geographic_locale

Example

null

string

The email address sent to the scheduling application for the person viewing the scheduling availability

CEL

profile_email_address

Example

"joe@bloggs.com"

object

HI PII (Optional) Data associated with the event, not automatically stored on the Morf Profile

CEL

event_data

Example

{
"referrer_domain": "example.com",
"referrer_url": "https://example.com/schedule-appointment"
}

⌘I

​Events

​Triggering Webhook Types

​Payload Field Details

Events

Triggering Webhook Types

Payload Field Details