ReferenceFor engineers
Care flow components as code
The JSON files and folder structure Awell writes to the repository when a care flow is synced.
When a care flow syncs to the repository, its components are written as JSON files in a fixed folder structure.
This structure is experimental. Awell may change it substantially without prior notice, so don't build tooling that depends on the exact shape without expecting to maintain it.
Folder structure: one file per component kind
repository
├── actions/actions.json
├── data_point_definitions/data_point_definitions.json
├── labels/labels.json
├── messages/messages.json
├── pathways/pathways.json
├── rules/rules.json
├── settings/settings.json
├── stakeholders/stakeholders.json
├── steps/steps.json
└── …The split keeps a diff readable: a change to a message shows up in messages.json rather than buried in
one enormous document.
What the files contain
- actions. The actions in the care flow, including API calls.
- data_point_definitions. The data point definitions, matching the data catalog.
- messages. Message content.
- pathways. The care flow definition itself.
- rules. The conditional logic.
- settings. Care flow settings.
- stakeholders. Who the care flow's actions are assigned to.
- steps. The steps and their structure.
- labels. The step labels.
The folder names use Awell's internal vocabulary: pathways holds what the product now calls care flows.
See Key terms.
Editing these files does not change the care flow
The sync is one-way. See How syncing works.
Next steps
Back to Data & source control.