Get action metadata

Note: The path is a placeholder. The actual path is determined by the configuration of the app component.

When a user has navigated to the custom rule builder UI and selected a rule action (either through the sidebar or via a rule preset), Asana will make a request to the app to get the configuration form definition for the chosen rule action. This will initiate the flow to configure a new rule action or edit the configuration of an existing rule action. This is the endpoint and schema for updating rule actions; app triggers (V2) will be analogous.


App components rule metadata request flow

Query Params
string

The ID of an existing rule action that is being edited. Should be omitted when configuring a new rule action.

string
required

The ID of the configuration used to create the rule action.

string
required

The project GID this hook is coming from.

string
required

The workspace GID this hook is coming from.

string
required

The user GID this hook is coming from.

string
required

The time (in ISO 8601 date format) when the request should expire.

Responses

Response body
object
string
required

The interface name and version of a distinct form UI layout. A template is directly associated with a particular metadata schema.

form_metadata_v0

object
required

The metadata (i.e., underlying definition) of a form. metadata must exist alongside a template, and its schema must be specific to the value of that template.

string
required

The title of the form, which is displayed at the top of the creation form

array
required

An array of form field objects that are rendered in the order they are in the array. Limit of 30 fields.

Valid object schemas: FormField-Checkbox, FormField-Date, FormField-Datetime, FormField-Dropdown, FormField-MultiLineText, FormField-RadioButton, FormField-RichText, FormField-SingleLineText, FormField-StaticText, FormField-Typeahead

fields*
string

The text to display on the form’s submit button. If not provided, the default text “Submit” will be displayed on the button.

string

The URL to POST the form to when the user clicks the submit button. If this is field is omitted then the submission button will be disabled. This is useful if the user must enter information in a watched field first, such as to show additional fields.

string

The URL to POST the form to whenever watched field values are changed.

Language
URL
Asana Home
Asana helps you manage projects, focus on what's important, and organize work in one place for seamless collaboration.
© 2023 Asana, Inc.