Awell
Extensions
How-toFor engineers

Store secrets

Keep API keys and credentials out of extension code by declaring them as settings, with different values per environment.

Secrets and environment variables are not stored in extension code. They go in extension settings instead.

Declare the setting in code, then read it in the extension's custom actions.

How a secret reaches an action

  1. The extension code defines the setting, marked obfuscated: true.
  2. The person installing the extension enters the value securely in the Awell platform.
  3. The action reads it from the payload at run time.

The code never contains the secret, only the name of a setting whose value someone else supplies.

The same setting holds different values per environment

Awell supports multiple environments, such as Sandbox and Production, and the same setting can hold a different value in each.

An extension installed in Sandbox points at a test account while the same extension in Production points at the real one, with no code difference.

Settings arrive in the onEvent payload

Settings arrive in the onEvent payload alongside the action's field values. See The onEvent function.

Next steps

Next: Create an action.

Extension settings

Define what the person installing an extension configures, including the secure way to handle API keys.

Create an action

Define a custom action — its metadata, how a care flow author configures it in Studio, and the logic that runs when a care flow activates it.

On this page

How a secret reaches an actionThe same setting holds different values per environmentSettings arrive in the onEvent payloadNext steps