Get rule action typeahead results

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

In a rule action typeahead form field, this operation gets typeahead results to render as a dropdown list. Typeahead results are limited to 50 items.

When the user types into a rule action form field, Asana will send a request containing the entered string to the application's typeahead_url. The list of TypeaheadItems in the response will then be rendered in a dropdown list.


App components rule typeahead request flow

Body Params

Request to retrieve typeahead results in a rule action typeahead form field.

string

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

string

The user GID this hook is coming from.

string

The workspace GID this hook is coming from.

string

The user's input in the typeahead text input.

string

Conditional. The task GID this hook is coming from. task is only present in the modal form (as there is a "context task"), but not in the rule action (as rules are associated with a project).

Responses

Response body
object
string

Optional. Header text to display above the list of typeahead results. If no header is passed in or the value is an empty string, only the typeahead results with be rendered.

array of objects
required

Array of TypeaheadItem objects that indicate typeahead results.

items*
object
string
required

The title of the typeahead item.

string

The subtitle of the typeahead item.

string
required

The value of the typeahead item.

string

The URL of the icon to display next to the title.

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.