Alert Task – SOAP API Request12 min read

Specifies the type of task input field displayed in the end-user interface to collect user input for the request object to assign to the Key value. The default setting is Textbox, but can be customized to any one of the following:

• Date – Displays the Format field where you can select the date format syntax for the end-user to define when the task is configured for their account. In the Select Date Format drop-down list, select one of the following:
  • dd-MM-YYYY – For example, 16-05-1999
  • MM-dd-YYYY – For example, 05-16-1999
  • dd-MM-YY – For example, 16-05-99
  • YYYY-MM-dd – For example, 1999-05-16
• URL – Displays a text box for the end-user to enter a URL including field validation for a correct URL syntax. In the Placeholder field, enter the help hint displayed in the text box, for example, Enter the URL for the website here.
• Textbox – Displays a text box for the end-user to enter text as the task input field, typically just a few words. In the Placeholder field, enter the help hint displayed in the text field, for example, Type in the name you want to embroider.
• Static Dropdown – Displays a drop-down list of choices to the end-user. Click Add Option to begin adding the list of items to display to the end-user with the following parameters:
  • Option Name – The name of the option displayed to the end-user.
  • Option Value – The value the represents the Option Name returned to the application.
  • Default Value – Select the default value for the option when more than one option is defined.
  • Searchable – Select to enable dynamic search and display as the end-user enters text in this field, or if no matches, allow free-form entry.

  Click Save. To add additional items, click Add Option again. Edit or remove options in the Actions column for options.

• Dynamic Dropdown – Displays a drop-down list dynamically populated at runtime based on the response from a URL for your Bot, for example, a list of projects for a JIRA task notification. Define the following properties for a dynamically populated dropdown.
  • Endpoint URL – The Bot endpoint URL, for example, https://app.asana.com/api/1.0/workspaces.
  • Endpoint Content Type – The content type expected from the specified endpoint URL. One of: JSON, RSS, XML, URL Encoded JSON, CCV, Text, or Twitter Encoded JSON.
  • Endpoint Method – One of:
    • GET – Specifies an HTTP Request GET method for the task field.
    • POST – Specifies an HTTP Request POST method for the task field.
  • Response Path – The path in the response that contains the desired drop-down list values, for example, data.
  • Label Key – The key for the label of the drop-down option, for example, name.
  • Option Value Key – The key for the value of the drop-down option, for example, id.
  • Add Payload Field – Click to add one or more fields from the response payload as options for the dynamic dropdown. For each payload field, enter the Payload field key and the Payload field value, and then click Save. Edit or delete payload fields in the Actions column.
  • Searchable – Select to enable dynamic search and display as the end-user enters text in this field, or if no matches, allow free-form entry.

• Textarea – Displays a text area box for the end-user to enter text as the task input, typically for several sentences. In the Placeholder field, enter the help hint displayed inside the text area.
• Type Ahead – Displays a dynamically populated drop-down list of choices to the end-user at runtime when the user enters three or more characters that match the search results based on the response from the URL defined for the task. For example, a list of projects for a JIRA task notification message. Define the following properties for a dynamically populated drop-down.
  • Endpoint URL – The Bot endpoint URL, for example, https://app.asana.com/api/1.0/workspaces.
  • Endpoint Content Type – The content type expected from the specified endpoint URL. One of: JSON, RSS, XML, URL Encoded JSON, CCV, Text, Twitter Encoded JSON, Multipart/Form-data, or Multipart/Related.
  • Endpoint Method – One of:
    • GET – Specifies an HTTP Request GET method for the task field.
    • POST – Specifies an HTTP Request POST method for the task field.
  • Response Path – The path in the response that contains the desired drop-down list values, for example, data.
  • Label Key – The key for the label of the drop-down option, for example, name.
  • Option Value Key – The key for the value of the drop-down option, for example, id.
  • Add Payload Field – Click to add one or more fields from the response payload as options for the type ahead field. For each type ahead field option, enter the Payload field key and the Payload field value, and then click Save. Edit or delete payload fields in the Actions column.
  • Editable – Enables the end-user to enter text free-from in the field as an option when type-ahead search results do not match.
• Email – Displays a text box for the end-user to input an email address. In the Placeholder field, enter the helpful hint to display to the end-user inside the text box.
• Date & Time – Displays a text box for the end-user to input a date with time. In the Format field, enter the expected date or time format to display to the end-user in the date text box. In the Select Date Format drop-down list, select the date with time format.
• Time Zone – Displays a drop-down list of time zones based on the operating system settings.
• Location – Displays a text box for the end-user to enter a geographical location, for example, Orlando, FL, or 32801.
• Nested Form – Displays end-user input fields in a nested format below the parent input field. Specify the following fields for a nested form input field:
  • Array Element Type – Select the data type of the parent input form element.
  • Add Nested Form Field – Click to add one or more nested form fields.
• File Upload – Displays end-user control to search for, and select a file to upload. When clicked, enter the File Upload Payload Key. When the File Upload Payload Key is defined, in the File Upload Payload Field Value drop-down list, select one of the following types:
  • File Name
  • File Size
  • File Content Type

Select one of these user input types:

• String – Users can input any sequence of numbers, letters, or special characters.
• Number – Users can input a number. No special characters are allowed.
• Boolean – User can input a Boolean value of true or false.
• Email – User can input a valid email address.
• Object – Data from a Bot can be received as JSON objects, for example, as location details defined as:
   “location” : {
                 “lat” : 17.4374614,
                 “lng” : 78.4482878
              }
  where you can refer to the properties in a request chain or task request as location.lat, and location.lng.
• Array – Users can pass a comma-separated list of values to the Bot. For example, in Google Calendar, multiple attendees with data can be passed as:
  “attendees”: [“user1”, “user2”, “user3”]
  When selected, specify the Type for the array of end-user input as one of:
  • String
  • Number
  • Boolean
  • Email
  • Array
  • Date
• Date – Users can type a complete date or select it from a date picker.

• Issue ID
• Comment

With the Visibility field set to Custom, you can capture the user information for the user mentioned as @Mike using the JIRA API to fetch data to append to the comment field value, but not to use as payload field or query field.
The default Visibility field setting is Visible.