Awell
Extensions
ReferenceFor engineers

onActivityCreated (deprecated)

The onActivityCreated function was deprecated on 1 September 2024. Use onEvent instead.

onActivityCreated was deprecated on 1 September 2024. Use onEvent instead.

This page is for anyone maintaining an older extension, or searching for the old function name.

What onEvent covers

onEvent covers what onActivityCreated did and more. It receives the same kind of payload, uses the same onComplete and onError callbacks, and adds helpers.

Migrating usually means renaming the function and checking the payload shape against The onEvent function.

Extensions still on the old function

Migrate them. There is no advantage to staying on a deprecated function.

Where onEvent doesn't cover something, email support@awellhealth.com rather than working around it.

The onEvent function

The function called when a care flow activates a custom action, with its payload, its callbacks, and the helpers available to it.

Test your extension

Run unit tests against extension code with jest, or run the full extension server locally against the pub/sub emulator.

On this page

What onEvent coversExtensions still on the old function