Form URL encoded data
- Updated: 2024/09/27
Form URL encoded data
Use the form URL encoded data request type to add various parameters to your request body.
Actions
The following 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 |
---|---|
Value is user provided | Shows if the value is user provided.
|
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 body parameters
- Click the Request body tab.
- From the Type drop-down list, select Form URL encoded data.
- Click Add parameter when no parameter exists or the plus (+) icon on the top of the table to add a parameter.
- In the Key field, enter an appropriate key. 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.
- 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 - Select whether you want the input value type to be secured. When you select secured, you will be able enter the parameter through a credential, variable, or insecure string.
- Select if this field is mandatory.
- 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.
- Enter a label. The package user will be able to view this label for the parameter in the Bot editor or API Task editor.
- (Optional) Enter a description. The package user will be able to view this description for the parameter in the Bot editor or API Task editor. It will appear as help text in the editor.