Awell Health Developer Hub
Dev Hub

You may choose to receive any or all of the below events. More information on how to configure webhooks for your pathway can be found here.

Events

Name
pathway.started
Payload
View payload
Description

Triggered every time a care flow/pathway is started.

Name
pathway.completed
Payload
View payload
Description

Triggered every time a care flow/pathway is completed.

Name
activity.created
Payload
View payload
Description

Triggered every time an activity in the care flow/pathway is created, including system activities.

Name
activity.completed
Payload
View payload
Description

Triggered every time an activity in the care flow/pathway is completed, including system activities.

Name
form.submitted
Payload
View payload
Description

Triggered every time a form is submitted.

Name
data_point.collected
Payload
View payload
Description

Triggered every time a new value for a data point is collected.

Name
reminder.created
Payload
View payload
Description

Triggered every time a reminder for a pending activity is created.

Name
session.started
Payload
View payload
Description

Triggered every time a hosted session is started.

Name
session.completed
Payload
View payload
Description

Triggered every time a hosted session is completed.

Name
session.expired
Payload
View payload
Description

Triggered every time a hosted session is expired.

Content included

PII

Some of our webhooks (might) contain Personally Identifying Information (PII) in their payload:

  • form.submitted and data_point.collected: by default, we include the response of the form or data point in the payload of the webhook and depending on the data you collect, it might thus include PII.
  • activity.created and activity.completed: the indirect_object field in the payload might contain PII information about the stakeholder the activity is assigned to.
  • reminder.created: information about the recipient is included in the payload.

All other webhooks don't have PII in their payload but might contain UUIDs to identify a resource (eg: patient id and pathway id).

Additional resources

More detailed information on our Webhooks and an interactive webhook builder can be found in the developer tools section.

Data schemaHealthcare interoperability