App components can also be used to extend rules, Asana’s native automation feature. Rules have two core features: triggers and actions. Triggers like user assigned or task created are set to automate actions like move task to section, etc. Actions can be customized with the rule action app component.

📘

Try app components with our interactive UI builder

For hands on learning, we recommend using our interactiveUI Builder to see how app component responses are generated.

Rule actions

A rule action allows users to customize actions triggered by Asana'srule engine. They function similarly to amodal form, as Asana requests a form definition from the app server. The app controls the form fields, handleson_change events, and stores the inputs of the form. When a rule is created, Asana sends a request to the app server with the user-specified inputs. When the rule is triggered, Asana sends an event to the app server.

🚧

Limit

There is a current limit of 10 rule actions created per application.

📘

Rule actions example app

To see an example app server written for rule actions, see ourapp-components-rule-action-example-app on GitHub.

Dynamic forms

You can includebranching logic in your rule action forms to create a dynamic user experience. That is, forms can change according to how the user responds to specific questions.

on_change_callback

Under the hood, branching is made possible byon_change events. While a user is filling out a form, the app server can receiveon_change requests. These requests include what the user has changed, and allow the app server to respond with an updated form (e.g., with new fields). To take advantage ofon_change events, you may set a form field'sis_watched value totrue and anon_change_callback endpoint to hit with updates.

See theon_change_callback property in the200 response to theform metadata request (alternatively, see theFormMetadata schema). The request sent to that endpoint is theon change callback request.

on_submit_callback

on_submit events allow the form to be submitted once all required fields are completed. As such, this property should only be provided during the "final branch" of your form. If theon_submit_callback property is omitted,the submission button will be disabled.

See theon_submit_callback property in theFormMetadata schema for an example.

Configuration

Rule actions documentation

View schemas related torule actionshere in the API reference.

Endpoints

• Get rule action typeahead results
• Run action
• Get action metadata
• On action change callback
• On action submit callback

Updated about 1 year ago