Connections
Last updated
Last updated
Connections in the Dynamiq platform are reusable configurations that enable seamless integration with external services, APIs, or data providers. By creating and managing connections, users can easily configure integrations once and reuse them across multiple workflows and other platform features. This approach minimizes redundancy and ensures a consistent setup for interacting with external resources.
To add a new connection:
Navigate to the Connections page and select Add new connection.
Fill out the form on the right panel:
Name: Enter a descriptive name for the connection.
Type: Select the connection type from the dropdown (e.g., OpenAI).
Depending on the selected type, fill in configuration fields such (e.g., API Key, URL).
Once all fields are filled out, click Create to save the connection.
To update an existing connection:
Navigate to the Connections page.
Find the connection you wish to update and click the Edit icon next to it. This will open the connection's configuration panel on the right side.
Modify connection-specific fields, depending on the connection type, you may see different fields.
After making the necessary changes, click Update to apply the updates to the connection.
In the Dynamiq platform, users can delete unused connections to keep their configurations clean and organized. However, before a connection is removed, the system will automatically check if it is actively in use within any workflows, deployments, or other platform components. If the connection is not in use, it will be removed successfully. If it is in use, an error message will appear, indicating that the connection cannot be deleted until it is no longer referenced.
To remove a connection:
Navigate to the Connections page.
Find the connection you wish to delete and click the Delete icon next to it.
Outcome:
If the Connection is not in use: the connection will be removed immediately, and it will no longer appear in the list of connections.
If the Connection is in use: you will receive an error message indicating that the connection cannot be deleted while it is actively referenced. To remove the connection, first detach it from any associated workflows.
