Update an extension's settings
Change an installed extension's settings in the Awell platform, including how a stored secret such as an API key is kept, replaced or removed.
An installed extension keeps its settings in the Awell platform: an API key, a sender address, the URL of an account. This page covers changing those settings, and the rules that apply to a setting the extension marks as secret.
To install an extension in the first place, see Integrate with extensions.
Open an extension's settings
- Open Integrations from the left navigation, then the Extensions tab.
- Under Installed, click Configure on the extension.
- Change what needs changing, then click Save.
A setting that isn't secret arrives prefilled with its stored value, so it can be read and edited in place. A secret doesn't; see below.
An extension that defines no settings says so instead of showing a form: "No settings available for this extension."
A secret setting is never shown back
Awell never sends a stored secret back to the browser. A setting the extension marks as secret shows as an empty, masked field carrying the placeholder "Stored: type a new value to replace it", with the hint "A value is stored, and is never shown. Leave this empty to keep it."
- Leave the field empty and the stored value is kept.
- Type a value and it replaces the stored one.
The eye icon next to the field shows what has been typed into it. It never reveals the stored value, because the page never receives one.
Settings are left out of Awell's logs too. A log line about an extension records the extension, the organization and the configuration it acted on, not the settings themselves.
Changing anything else means entering every stored secret again
A stored secret is used only with the settings it was saved with. A save that changes any other setting is therefore refused while a stored secret is left empty, and the refusal names each secret to enter again:
Enter it again: another setting changed, and a stored secret is used only with the settings it was saved with.
The rule covers every setting, secret or not, because a setting that is not itself a credential often decides where the credential is sent: an API URL, a host, an account. Keeping the two together stops a stored key from being redirected to a destination chosen by someone who never knew the key.
The cost is real and worth planning for: rotating one secret means entering the others again. A save that touches nothing but leaves every stored secret empty is still fine. That is the no-op case, and the stored values survive it.
Remove a stored secret
A stored secret the extension doesn't mark as required can be cleared:
- Click Remove the stored value under the field. The form confirms: "The stored value will be removed when you save."
- Click Save.
Keep it undoes the removal before the save. A required secret can't be removed, only replaced.
Removal counts as a change, so any other stored secret has to be entered again in the same save.
Limits on what a save carries
- A setting's value is at most 10,000 characters, which fits a Base64 private key.
- A save carries at most 100 settings.
- Only settings the extension defines are accepted. If the extension's settings changed while the page was open, the save is refused with a message naming the unknown setting; reload the page and save again.
Who can change settings
Viewing the Extensions tab and an extension's settings needs a role that grants permission to read the organization's settings. Installing, uninstalling and saving need permission to change them. See Integrate with extensions.
Uninstall an extension
Click Uninstall on the extension's settings page and confirm. The settings are kept, so installing the extension again restores them.
While an extension is uninstalled, any care flow action that uses it fails. Check which care flows rely on it before uninstalling.
Next steps
Next: Extension settings: for the people building an extension, how a setting is declared and marked secret in the first place.
Integrate with extensions
Install a prebuilt connector for an EHR, messaging provider or e-signature service, and get custom actions and webhooks without configuring API calls.
Awell and Healthie
What connecting Awell to Healthie's EMR makes possible, and how a care flow automates actions in Healthie through its GraphQL API.