Awell Hosted Pages
Learn how to obtain an URL to Hosted Pages for your patients and other stakeholders
You will need a URL in order to direct a patient (or other stakeholder) to Hosted Pages. There are two options to obtain such a URL: Hosted Pages Links and Sessions (with session URLs).
Both Hosted Pages Links and Sessions serve the same purpose: there is a new activity in the care flow that requires a patient's attention (e.g. a form to fill). In order to let the patient complete the activity, we need a URL that allows them to complete the activity on Hosted Pages.
Ultimately, both Sessions and Hosted Pages Links result in a URL that directs you to Hosted Pages. What distinguishes the two, and how does one decide which to use?
Get a shareable, static link generated by Awell
You want to get started quickly.
Awell communicates directly with the patient (e.g. via SMS or email).
| Feature | Included |
|---|---|
| Prerequisites | No |
| Trigger | No |
| Trigger sent to | Your system (e.g. via API call action, webhook, ...) or directly to the patient (e.g. SMS/email). |
| URL created by | Awell but configured by you in Awell Studio when designing the care flow (read more). |
| URL generated when | Upfront, when care flow is started. The URL is immediately included in the payload sent to your system or notification to the patient. |
| Scope | No |
| Expiration | No, never. It's a static link. |
| Set success/cancel URLs | Limited control but improved support coming. |
| Webhook support | No |
| Multi-language support | No |
Create a session via Awell's API which returns a session URL
You prefer complete control over the creation of sessions and care about limited validity of links.
| Feature | Included |
|---|---|
| Prerequisites | No |
| Trigger | No |
| Trigger sent to | Your system (e.g. via API call action, webhook, ...). |
| URL created by | You, programmatically via Awell's API (read more). |
| URL generated when | Just-In-Time, when a patient clicks a Call To Action button. |
| Scope | No |
| Expiration | Yes, after 60 minutes. |
| Set success/cancel URLs | Yes, full control. |
| Webhook support | Yes |
| Multi-language support | No |
| Hosted Pages Links | Sessions | ||
|---|---|---|---|
| Description | Get a shareable, static link generated by Awell | Create a session via Awell's API which returns a session URL | |
| Use when | You want to get started quickly. Awell communicates directly with the patient (e.g. via SMS or email). | You prefer complete control over the creation of sessions and care about limited validity of links. | |
| Effort | |||
| Details | |||
| Prerequisites | There is a care flow started**. | ||
| Trigger | There is a new activity in the care flow that needs completion by a patient. | ||
| Trigger sent to | Your system (e.g. via API call action, webhook, ...) or directly to the patient (e.g. SMS/email). | Your system (e.g. via API call action, webhook, ...). | |
| URL created by | Awell but configured by you in Awell Studio when designing the care flow (read more). | You, programmatically via Awell's API (read more). | |
| URL generated when | Upfront, when care flow is started. The URL is immediately included in the payload sent to your system or notification to the patient. | Just-In-Time, when a patient clicks a Call To Action button. | |
| Scope | Only gives access to activities for a single patient/stakeholder in a single care flow. | ||
| Expiration | No, never. It's a static link. | Yes, after 60 minutes. | |
| Set success/cancel URLs | Limited control but improved support coming. | Yes, full control. | |
| Webhook support | Not included in Hosted Pages Links | Included in Sessions | |
| Multi-language support | Included in join | ||
** There are use cases, like onboarding and intake flows, where you might want a patient to self-enroll in a care flow and immediately let them complete activities in their care flow. Both for Links and Sessions there is an easy way to do that with a
shareable Hosted Pages Link
.
Example: a patient visits your website and there's a button to start an onboarding flow. Clicking the button should both start a care flow and immediately allow the patient to complete activities in that care flow.
Hosted Pages Links are the quickest way to get started sending your patients to Hosted Pages and let them complete activities. It requires zero engineering resources as they are generated by Awell and sent to your system or directly to the patient via SMS, email, or other channels at the right time.
Hosted Pages Links are static, don't expire, and are unique per patient per care flow. A single link thus only gives access to pending activities in one care flow and one patient.
Although Hosted Pages Links are generated by Awell, it's up to you, the care flow builder, to insert these links in the appropriate actions of the care flow. You can find more information about how to that in this help article. A couple of examples:
A Hosted Pages Session represents your patient's session as they complete activities in their care flow through Hosted Pages. Sessions are created just-in-time and programmatically by you, the customer, using Awell's API.
When creating a session, you need to specify details like who the session is for, the care flow involved, and a success URL where patients are sent after they complete all activities. This setup shapes what activities a patient can interact with and how things work once they're done. After creating a Session, redirect your patient to the Session’s URL to let them complete their pending activities.
A session expires after 60 minutes but the timer is reset after every completion of an activity. A session also expires when there are no pending activities left in a care flow.
Additionally, sessions also support webhooks which allows you to be notified when a session is started, completed, or expired.