Use the Request tab section to add headers to your requests.

Actions

The following request header actions are enabled:

Add
To add headers to the request.
Click the Add icon to add a header. The header count displayed on the Headers table title is updated automatically.
Edit
To edit the existing headers that are available in the request.
In the Headers table, hover over the vertical ellipsis icon of the appropriate header, and click the Edit icon to edit the Key and Value.
Delete
To delete the headers that are available in the request.
Do one of the following to delete headers:
  • Click Select all check box in the table header, and then click the Delete icon that is available above the table to delete multiple headers .
  • Hover over the vertical ellipsis menu of each header and then click Delete icon to delete the header individually.

Headers table

View the following header details in the table.

ColumnDescription
Key Displays the key name. The package user cannot view the key name in the Bot editor or API Task editor. This name is sent as part of the header.
Value Displays the header 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 header 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 header label. The package user can view the header label in the Bot editor or API Task editor.
Description Displays the header description. The package user can view the header description in the Bot editor or API Task editor.

Add request headers

Perform these steps to add a header:

  1. Click the Request headers tab within the Configuration pane.
  2. Click Add header or the plus (+) icon on the top of the table to add a header.
  3. Do the following in the Add header 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 header. 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 header through a credential, variable, or insecure string.
      2. Is this field mandatory?: Select No or Yes depending on the requirements of the header.
      3. Value: 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 header. The package user can view the header value in the Bot editor or API Task editor.
      5. Description: Enter a description for the parameter. The package user can view header description in the Bot editor or API Task editor. The description appears as help text in the editor.
  4. Click Add to add the header to the request.

    The new header is displayed on the Headers table and the header count in the table title is updated automatically.

Repeat the steps to add more headers.