Most organizations using Awell work with two environments:
Sandbox – where you build, test, and validate your care flows.
Production – where you Orchestrate care flows with real patients.
Workflow overview
The recommended workflow is simple:
Build in Sandbox → Promote to Production
You’ll start by building and testing your care flow in Sandbox. Once it’s ready, you can promote it to Production.
How to promote a care flow
In the Awell app, go to Settings > Promotion.
Follow the on-screen instructions.
Only users with the Admin role can perform promotions.
Promotion will copy the current working version of your care flow from Sandbox to Production.
❗Note: Promoting a care flow does not automatically publish it in Production. You’ll still need to manually publish in the Production environment.
Impact on integrations
If you have integrations that rely on identifiers—like pathway definition IDs or data point IDs—there’s no need to worry. When you promote care flows to Production, these identifiers remain unchanged, allowing you to build and maintain your integrations in Production using the same logical IDs from Sandbox.
View-only mode in Production
When you open a promoted care flow in Production, it will be in view-only mode by default. This is intentional – it ensures that edits are always made in Sandbox and then promoted.
That said, direct edits in Production are allowed (for example, to apply a hotfix), but you must remember to replicate those changes manually in Sandbox to avoid losing them later.
⚠️ Making direct edits in Production can cause your environments to become out of sync. These changes will be overwritten the next time you promote from Sandbox unless you replicate your changes in Sandbox.
Go live checklist
Before going live with a promoted care flow—especially the first version—make sure the following configurations are set up correctly in the Production environment:
Extensions
Extensions are not included in the promotion process. Ensure you install all required Extensions in Production with the right credentials.
Constants
Set up global and care flow constants with the correct values in Production.
Care flow constants are automatically included during promotion. If the value needs to be different in Production, simply update it after promotion.
Global constants, however, are not included in the promotion process. You need to recreate them in Production.
When you re-promote a care flow but have manually set or updated the value of a care flow constant in the Production environment, Awell will not overwrite that value during promotion.
Enrollment Triggers (incoming webhooks)
Enrollment triggers are not included in the promotion process and have to be recreated in Production.
Webhook URLs are different between environments. Ensure you’ve subscribed to the correct Production webhook URL in any third-party system.
Outgoing Webhooks
Outgoing webhooks are not included in the promotion process. Ensure to set up outgoing webhooks in Production to send Awell events to your third-party systems.
File Upload
File storage configuration is not included in the promotion process. Configure File Storage separately in Production if your care flow uses file uploads.
Orchestration API Integrations
API keys are not included in the promotion process. If you integrate with Awell’s Orchestration API, you’ll need to generate a Production API key.
Branding Configuration
Branding configuration at the organization level is not included in the promotion process. If you have branding set at the organization level (e.g., colors, logo), set it separately in Production.
Custom Domains for Hosted Pages
Custom domains are not included in the promotion process. Ensure to set up custom domains in Production for links to Hosted Pages.
API Retry Configuration
API retry configuration at the organization level is not included in the promotion process. If you’re using custom retry settings for APIs at the organization level, configure them in Production.
Identifier Systems
Identifier systems are not included in the promotion process. Set up your Identifier Systems separately in Production. Make sure the name and system are identical to Sandbox.