Configure action in connector editor
- Updated: 2025/09/03
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
- 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.
- 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