Request parameters

Use the Request parameters section to add various parameters such as path and query to your requests. Ensure that these parameters match the parameters used in the endpoint URL.

Actions

The following request parameter actions are enabled:

Add
Click to add a parameter.
Edit
Mouse over the three dots icon of the parameter that you want to edit and click the edit icon.
Delete
Delete the selected parameters.

Parameters table

View the following parameter details in the table.

Table item Description
Type Shows if the parameter is a query parameter or type parameter. Parameter type is not displayed to the package user in the Bot editor or API Task editor.
Value is user provided Shows if the value is user provided.
  • Shows Yes if the value is user provided. The package user will need to provide an appropriate value when configuring this parameter in the Bot editor or API Task editor.
  • Shows No if the value is hard coded. The package user will not be able to view this value in the Bot editor or API Task editor. This value is sent as part of the header.
Key Shows the 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.
Value Shows the parameter value. The package user will be able to view this value in the Bot editor or API Task editor and can update this value.
Label Shows the parameter label. The package user will be able to view this label for the parameter in the Bot editor or API Task editor.
Description Shows the parameter description. The package user will be able to view this description for the parameter in the Bot editor or API Task editor.

Add request parameters

  1. Click the Request parameters tab.
  2. Click Add parameter or the plus (+) icon on the top of the table to add a parameter.
  3. In the Add parameter window, select one of the following parameter types:
    • Query: These parameters are appended to the URL path after a ? character. For example, /accounts?user_account=company.
    • Path: These parameters are directly appended to the URL path. For example, /accounts/{user_account}.
  4. In the Key field, 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.
  5. Select one of the following options:
    Hard coded Enter a value that is hard-coded for the parameter. The package user will not be able to view this value in the Bot editor or API Task editor. This value is sent as part of the header.
    User provided
    1. Select if this field is mandatory.
    2. Enter a value. The package user will be able to view this value in the Bot editor or API Task editor and can update this value.
    3. Enter a label. The package user will be able to view this label for the parameter in the Bot editor or API Task editor.
    4. Enter a description. The package user will be able to view this description for the parameter in the Bot editor or API Task editor.