When you add an action manually, you must configure the action details by adding the path and query parameters, headers, requests, and response.

When you import API definition, you need to verify and edit the action details to ensure that the action has the appropriate values based on your requirements. These details will displayed in the Bot editor or API Task editor when using the package. When you add an action, the Actions configuration page displays. The Configuration tab displays various configuration settings and the Test tab allows you to test the action. The following settings are available in the Configuration tab.

Settings in Configuration tab

HTTP Method
Specify the type of REST request that you must send to the REST API server. The following HTTP methods are supported:
  • GET
  • PUT
  • POST
  • DELETE
  • PATCH
Note: When you import an API definition, the connector editor ignores actions with unsupported methods and includes the rest in the custom connector.
Endpoint
Enter the endpoint URL that you use for this action. The package user cannot see this URL. Use braces {} to enclose the path and query parameters in the URL. For example, /{version}/product/{productid}?status={productStatus}.
Full URL
This read-only field displays the auto generated field that combines the base URL that you enter when you create the package and the endpoint URL from Endpoint field. This URL will not be visible for the package user.
Request parameters
Request parameters enable you to identify, sort, and filter the responses from the API server. Use the Add parameter option to add request parameters. You can add path and query parameters. Ensure that the parameters match the Endpoint URL path. For more information about adding request parameters, see Request parameters.
Request headers
Request headers allow you to add additional information to the request. You can add request headers such as Accept, Content-Length, Content-Type, and Cookie. For more information about adding request headers, see Request headers.
Request body
Request Body allows you to import a sample payload to define the structure of the request body. The payload is the actual data that is required to create, update or delete a resource in the API server. When the action runs, the request includes this payload. For more information about adding request body, see Request body.
The following options are available:
  • JSON: Select this option to import a JSON sample to map the request body attributes. Leaf nodes will be captured and displayed here as a list of attributes. JSON provides flexibility with its key-value pair structure. For more information about JSON option in request body, see JSON.
  • Form data: Select this option to add form data parameters as request body attributes. The Form Data option is useful for uploading files to the REST API server by specifying the content type. For more information about Form data option, see Form data.
  • Form URL encoded data: Select this option to add request body parameters in HTML form as URL encoded key-value pairs similar to the query type request parameters. For more information about Form URL encoded data encoded data, see Form URL encoded data
Response
Response option allows you to import a sample payload from response and choose the attributes that you want to display in the Bot editor and API Task editor. For more information on adding a response parameter, see Response