Concept
Extensions
How a care flow reaches other systems: using an extension from the marketplace, or building and deploying a new one.
An extension gives a care flow a new ability: book an appointment, send an SMS, write a note back to an electronic health record. Without one, a care flow can only work with what's already inside Awell.
Using an extension
- What are Awell Extensions?. The concept, public versus private.
- What are custom actions?. What installing an extension adds to the action list.
Using a custom action once it's installed is a care-flow author's job, so it lives in Design care flows: Add a custom action to a step.
Installing an extension is covered in Integrate with extensions. Browse what exists in the Marketplace.
Building an extension
- Build your own extension. Why, and what needs installing.
- Create an extension. Folder structure and properties.
- Extension settings. What the installer fills in.
- Store secrets. Where API keys go, and where they must not.
- Create an action. Defining a custom action.
- Action fields. How an author configures an action in Studio.
- The onEvent function. Where an action's logic lives.
- Test your extension
- Deploy your extension
- Versioning
- Contributing guidelines. For public extensions.
Who this is for
Using an extension is a care flow author's job: pick it and configure it in Studio. Building one is an engineer's job and needs TypeScript.