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
Hide fields
Hide fields
The scheduling application being used
CEL
application
Example
scheduling.v1.SchedulingApplication.HEALTHIE
scheduling.v1.SchedulingApplication.ACUITY
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
Appointment type information, the ID, name (title), and default length in minutes
CEL
appointment_type
Example
{
"id": null,
"length_minutes": null,
"name": null
}
Description coming soon
CEL
appointment_type.id
Example
null
Description coming soon
CEL
appointment_type.name
Example
null
Description coming soon
CEL
appointment_type.length_minutes
Example
null
List of US state codes where the provider is licensed
CEL
licensed_geographic_locales
Example
[
"CA",
"NY"
]
List of provider specialties
CEL
specialties
Example
[
"Cardiology",
"Pediatrics"
]
Internal tags associated with the timeslot selection
CEL
internal_tags
Example
[
"high_priority",
"new_patient"
]
Start date of the viewed calendar range
CEL
start_date
Example
"2025-01-01"
End date of the viewed calendar range
CEL
end_date
Example
"2025-01-07"
The date the user clicked on to see available time slots
CEL
viewed_date
Example
"2025-01-03"
Number of available timeslots on the viewed date
CEL
num_timeslots_on_viewed_date
Example
7
Number of available timeslots in the viewed date range
CEL
num_timeslots_in_range
Example
42
Hours until the next available timeslot in the calendar date-range
CEL
hours_until_next_available_timeslot
Example
24
List of providers whose schedules were viewed
CEL
providers_viewed
Example
[
{
"name": "Dr. Jane Smith",
"provider_id": {
"id": null,
"id_type": null
}
}
]
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
}
]
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
Mapped array of: The name of the provider
CEL
providers_viewed.map(x, x.name)
Example
[
"Dr. Jane Smith"
]
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"
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
}
}
Description coming soon
CEL
insurance_payer.insurance_payer
Example
{
"ehr_id": null,
"id": null,
"name": null
}
Description coming soon
CEL
insurance_payer.insurance_payer.id
Example
null
Description coming soon
CEL
insurance_payer.insurance_payer.name
Example
null
Description coming soon
CEL
insurance_payer.insurance_payer.ehr_id
Example
null
Description coming soon
CEL
insurance_payer.geographically_scoped_insurance_payer
Example
{
"geographic_locale": null,
"insurance_payer": {
"ehr_id": null,
"id": null,
"name": null
}
}
Description coming soon
CEL
insurance_payer.geographically_scoped_insurance_payer.insurance_payer
Example
{
"ehr_id": null,
"id": null,
"name": null
}
Description coming soon
CEL
insurance_payer.geographically_scoped_insurance_payer.insurance_payer.id
Example
null
Description coming soon
CEL
insurance_payer.geographically_scoped_insurance_payer.insurance_payer.name
Example
null
Description coming soon
CEL
insurance_payer.geographically_scoped_insurance_payer.insurance_payer.ehr_id
Example
null
Description coming soon
CEL
insurance_payer.geographically_scoped_insurance_payer.geographic_locale
Example
null
The email address sent to the scheduling application for the person viewing the scheduling availability
CEL
profile_email_address
Example
"joe@bloggs.com"
HI PII (Optional) Data associated with the event, not automatically stored on the Morf ProfileCEL
event_data
Example
{
"referrer_domain": "example.com",
"referrer_url": "https://example.com/schedule-appointment"
}
