The Response tab enables you to import a sample payload from response and choose the attributes to display in the Bot editor and API Task editor.

Defining the response payload allows you to select the attributes that are contextual for the configured action. You can import the response payload from the API definition and retain the attributes that are mandatory using the Import sample action in the Attributes pane. You can then select the imported attribute and define valid name and type for the attribute.

The response data of any action includes the following keys:

  • headers: Store the headers of the API call response data in a dictionary variable.
  • response: Store the response data of the API call in a string variable.
  • statusCode: Store the API response status code in a number variable.

In the Response tab, use the Import sample option to add the sample response payload. Paste the sample payload in the Import sample modal, and click Import. The attributes of the imported sample payload appears in the Attributes pane. Selecting each attribute displays details of the attribute in the Map attribute pane. You can define the name and the input type of each attribute as per your requirements.

Attribute Description
Name Specifies a valid name for the attribute. This name serves as the identifier for the corresponding key in the response payload. The action displays this name in the setting for assigning the response data to a variable in the editor.
Input type Specifies the input type based on the data format of the response payload key. You can choose the appropriate input type based on the API definition.