Validating connections

Edit online

Use the Validate connection configuration section in the Connection property configuration tab of the Connector Development Kit to verify that the connection to your application works as expected with the defined properties.

This test confirms whether the selected authentication method (Basic, Bearer token, or API key) can successfully authenticate and access the application. To test the connection, Connector Development Kit makes an API call to one of the application's endpoints. You can either use an existing action that is configured in the Actions tab or define a custom action specifically for testing the connection.
Note: If you import an older connector file that does not include a test connection configuration, the section is locked for that authentication type and cannot be updated.

Use an existing action

The Actions tab lists all configured actions that use the GET method. These actions are recommended for testing because they do not modify application data at run time. Select one of these actions to validate connectivity by using the chosen authentication method.

Configure a custom action

If no suitable action exists, you can create a custom action to test the connection. Avoid using actions that modify the application’s user interface or data. When you configure a custom action, provide the following details.
Tip: For detailed information about different parameters, see Describing Parameters on the Swagger documentation page.
Base path

The base path is the URL prefix for all API endpoints, relative to the host root. It must begin with a forward slash (/). If no base path is specified, it defaults to /. For example, if the base path is /api and the endpoint is /users, the full URL is http://example.com/api/users.

Method
Select the HTTP method to use for the API call. Supported methods include:
  • GET: Retrieves data without modifying the application.
  • POST: Sends data to the server, typically used to create or update resources.
  • HEAD: Retrieves metadata about a resource without returning the body. Use this method to check the availability or status of an endpoint without transferring data.
Body (for POST method)

The body contains the JSON payload that is sent with a POST request.

Example:
{
  "username": "john_doe",
  "email": "john.doe@example.com"
}
Query parameters

Query parameters are appended to the URL to filter or customize the response. They follow a question mark (?) and are separated by ampersands (&). For example, https://api.example.com/users?username=john_doe&status=active.

To add a query parameter, click Add query parameter +. To configure a query parameter, provide a Name and Value.

Header parameters

Header parameters are included in the HTTP request header and are commonly used for authentication tokens, content negotiation, or caching directives.

Example:
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: application/json

To add a header parameter, click Add header parameter +. To configure a header parameter, provide a Name and Value.

Cookie parameters

Cookie parameters are sent in the Cookie header and are used to maintain session state or user preferences.

Example:
Cookie: session_id=abc123; theme=dark

To add a cookie parameter, click Add cookie parameter +. To configure a cookie parameter, provide a Name and Value.