Use the form URL encoded data request type to add various parameters to your request body.

Actions

The following parameter actions are enabled:

Add
To add parameters to the request body.
Click Add parameter or Add icon to add a parameter. The parameters count displayed on the Parameters table title is updated automatically.
Edit
To edit the existing parameters that are available in the request body.
In the Parameters table, hover over the vertical ellipsis icon of the parameter that you want to edit and then click Edit icon. You can edit the Key and the values of the parameters in the Edit parameter modal.
Delete
To delete the parameters that are available in the request body.
Do one of the following to delete parameters:
  • Click Select all check box in the table header, and then click the Delete icon that is available above the table to delete multiple parameters
  • Hover over the vertical ellipsis menu of each parameter and then click the Delete icon to delete the parameter individually.

Parameters table

View the following parameter details in the table.

Table itemDescription
Key Displays the parameter key. The package user cannot view the key in the Bot editor or API Task editor. The key is sent as part of the header.
Value Displays the parameter value. The package user can view this value in the Bot editor or API Task editor and can update this value.
Value is user provided Displays the status of the value.
  • Yes: If the value is user provided. The package user must provide an appropriate value when configuring this parameter in the Bot editor or API Task editor.
  • No: If the value is hard coded. The package user cannot view this value in the Bot editor or API Task editor. This value is sent as part of the header.
Label Displays the label for User provided values. The package user can view parameter label in the Bot editor or API Task editor.
Description Displays the parameter description. The package user can view the parameter description in the Bot editor or API Task editor.

Add request body parameters

Perform these steps to add a parameter to the form URL encoded data request body:

  1. Click the Request body tab within the Configuration pane.
  2. From the Type drop-down list, select Form URL encoded data.
  3. Click Add parameter when no parameter exists or the plus (+) icon on the top of the table to add a parameter.
  4. Do the following in the Add parameter modal.
    1. Key: Enter an appropriate key name. The key name is not displayed to the package user in the Bot editor or API Task editor. This name is sent as part of the header.
    2. Select one of the following options in the Value will be section:
      Type Description
      Hard coded Enter a value that is hard-coded for the parameter. The package user cannot view this value in the Bot editor or API Task editor. This value is sent as part of the header.
      User provided
      1. Value input type: Enable this check box if you want to secure the value input type. When you select secured, you can enter the parameter through a credential, variable, or insecure string.
      2. Is this field mandatory?: Select No or Yes depending on the requirements of the parameter..
      3. Value (optional): Enter a value. The package user can view this value in the Bot editor or API Task editor and can update this value.
      4. Label: Enter a label for the parameter. The package user can view the parameter label in the Bot editor or API Task editor.
      5. Description (optional): Enter a description for the parameter. The package user can view the parameter description in the Bot editor or API Task editor. The description appears as help text in the editor.
  5. Click Add to add the parameter to the request body.

    The new parameter is displayed on the Parameters table.

Repeat the steps to add more parameters to the request body.