Awell Health Developer Hub
Dev Hub

Within your action code, you will:

  1. Define some basic settings about your action like the title, icon, and category
  2. Define how your action can be configured by the user
  3. Define the logic of what needs to happen when the action is activated in a pathway.

Action properties

Required properties

Name
category
Type
string
Description

The category of your action. In Awell Studio, actions are logically grouped and shown to the user based on the category. Needs to be one of the predefined categories.

Name
description
Type
string
Description

A human-readable description of your action.

Name
fields
Type
object
Description

The configuration fields for your action. These configuration fields are displayed in Awell Studio when a user adds the action to a pathway. Learn more about action fields here.

Name
key
Type
string
Description

A unique identifier for your action. We recommend using a camelCase string.

Name
onActivityCreated
Type
function
Description

When your action is activated, the Awell system publishes a message that is received by the extension server, which will call the `onActivityCreated` function defined in your action. In this function you will write the logic to handle what needs to happen when your action is activated. Learn more about the `onActivityCreated` function here.

Name
title
Type
string
Description

The title or name of your action. By convention, action titles should always start with a verb (eg: send sms, schedule appointment, generate random number, ...).

Optional properties

Name
dataPoints
Type
object
Description

/

Name
previewable
Type
boolean
Description

When set to `true`, your action will be executed in preview as it would be in orchestration. Defaults to `false`.

Example

01