Hooks Reference

Overview

Extensions can integrate with the Angage ERP runtime by declaring hooks in their manifest.json. Hooks are split into two categories: actions and filters. They are declared under the hooks.action and hooks.filter arrays in the manifest.

Declaring Hooks

Add a hooks object to your manifest with the action and filter names your extension wants to listen for:

{
    "hooks": {
        "action": ["invoice.before_save", "customer.after_create"],
        "filter": ["invoice.totals", "product.price"]
    }
}

Action vs Filter

Actions are fired for side effects. The ERP notifies your extension that an event occurred (for example, a customer was created) and your extension may perform additional work in response. Actions do not return values to the ERP.

Filters are used to transform values. The ERP passes a value to your extension and expects a (possibly modified) value back. Filters can be used to adjust totals, prices, labels, or other data before the ERP uses them.

Hook Registry

The full action and filter hook registry is being expanded. Extensions may declare hooks in their manifest, and the ERP runtime will invoke them when the corresponding events occur. Contact [email protected] for the current list of invocable hooks.