Custom integrations, like built-in integrations, typically rely on a defined set of custom connection parameters to establish connectivity with the D3 platform. These parameters may include server URL, access token, API version, username, password, client secret, or others, depending on the specific requirements of the integration.
Custom Connection Parameter Interface
Configuring custom connection parameters modifies the connection setup modal to include input fields, where users can enter values for the defined parameters.
FORMATTING REQUIREMENT
Use only lowercase letters in the Parameter Name field.
Connection Setup Modal
Before Creating Custom Connection Parameters
After Creating One of Each Type of Custom Connection Parameter
READER NOTE
The Connection Health Check checkbox is included by default.
Lines 3: The connector variable provides access to the parameters configured in step 1.
Lines 5-10: Retrieve user-entered values from step 3, using get(<parameter name>).
Lines 12-17: Log the retrieved values to the Test Result > Custom Log tab (step 5).
Lines 19-33: Placeholder output values used to ensure that the Custom Log tab renders in the test result popover (step 5).
Ensure that the function name exactly matches the internal command name displayed in the Overview > Settings tab, directly beneath the command display name.
Click on the Custom Log tab to observe the values.
Establishing Connections
Establishing connections for custom integrations involves configuring the vendor-side environment, identifying appropriate endpoints for connectivity validation, and setting up the D3 platform with corresponding connection parameters that support those endpoints.
The example below demonstrates a simplified process of establishing connectivity, using minimal vendor-side setup and widely used connection parameters.
Example - Mistral AI (Server URL, API Version, API Key)
OBJECTIVE – Establish connectivity for a custom Mistral AI integration using custom connection parameters.
Line 14: The connector variable provides access to the parameters configured in step 13.
Lines 16-22: Extracts, sanitizes, and logs all connection parameter values to the Test Result > Custom Log tab (step 17).
Lines 24-29: Initializes required variables for command output model.
Lines 32-33: Constructs and logs the full API endpoint URL used in the HTTPS GET request.
Lines 34-36: Prepares the HTTP headers required for API authorization.
Line 38: Sends an HTTP GET request to the constructed Mistral API URL using defined headers and timeout.
Lines 40-45: Processes the response from the Mistral API.
On success (HTTP 200), parses and counts models returned in the "data" field.
On failure, captures and formats the error message.
Lines 47-49: Logs any exceptions raised during the HTTP request.
Lines 51-58: Returns the results of the test connection using D3's standardized output format. The output is displayed in the Test Result popover for review.
Review output tabs in the Test Result popover to verify the connection.
JavaScript errors detected
Please note, these errors can depend on your browser setup.
If this problem persists, please contact our support.