Skip to content

Credentials and Secrets

A connection profile stores the credentials and settings needed to connect to one external system. Every job in EZY Integrations links a source profile to a target profile, so you must create at least two profiles before you can run a sync.

Connection profiles are scoped to a tenant. Credentials are encrypted at rest and are never displayed in full after saving — the edit form shows a masked placeholder (••••••••) wherever a secret was previously stored.

Navigate to Connection Profiles in the left sidebar to see all profiles for the current tenant.

Connection Profiles list

The list shows:

ColumnDescription
NameThe label you gave the profile.
System TypeThe connector type (for example, SAP Business One or Shopify).
StatusActive or inactive. Inactive profiles cannot be used in jobs.
CreatedDate the profile was created.

Use the search bar to filter by profile name. The list is paginated in groups of 25.

  1. From the Connection Profiles list, click Create Profile.
  2. Enter a Profile Name. Choose a descriptive name that identifies the system and environment (for example, SAP B1 – Production or Shopify – Main Store).
  3. Select the System Type for the connector you want to configure.
  4. Optionally set Max Concurrent to limit how many parallel pipeline workers this profile can use at once (1–100). Leave blank to use the system default.
  5. Fill in the credential fields for the selected system type (see the section below for a summary by type).
  6. Click Test Connection to verify the credentials before saving.
  7. Click Create Profile to save.

Connection profile create form

Each system type has its own set of credential fields. The table below summarizes the available types and links to the full credential reference for each connector.

System typeDirectionCredential sectionsFull reference
SAP Business OneSource + TargetDatabase connection, Service Layer (optional), File paths (optional)SAP Business One
EZY PortalSource + TargetPortal URL, API keyEZY Portal
ShopifySource + TargetShop domain, Auth mode (OAuth or Legacy token), Advanced settingsShopify
WooCommerceSourceStore URL, REST API credentials, WordPress Auth (optional)WooCommerce
WixSourceAPI key, Site IDWix
Flat FileTargetOutput directory, Format (CSV or XML), Filename patternFlat File
Generic APITargetBase URL, Auth type, Auth fields, Content typeGeneric API

Each connector page listed above contains the authoritative table of credential fields, required/optional status, and example values.

The Test Connection button appears at the bottom of each credential section on the create and edit forms. Click it at any time to verify that EZY Integrations can reach the external system using the current credentials.

  • A green banner with a latency reading indicates a successful connection.
  • A red banner with an error message indicates a failure. The message will describe the problem (for example, authentication error, host unreachable, or invalid URL).

For multi-section connectors (SAP Business One has three separate test buttons for the database connection, Service Layer, and file paths), each section can be tested independently.

Testing uses the values currently entered in the form. If you have not changed any credential fields on the edit form, the test uses the previously saved encrypted credentials.

  1. In the Connection Profiles list, click Edit on the row you want to change.
  2. Update the Profile Name, Active status, or Max Concurrent value as needed.
  3. To update credentials, type the new value into the relevant field. Fields that already contain a saved secret show ••••••••. You only need to re-enter fields whose values have changed — leaving a field blank preserves the previously stored value.
  4. Click Test Connection to verify the updated credentials.
  5. Click Save.

Connection profile edit form with masked credentials

Rotating Secrets Without Disrupting Running Schedules

Section titled “Rotating Secrets Without Disrupting Running Schedules”

When a credential needs to be rotated (for example, after an API key is regenerated in the source system):

  1. Open the edit form for the affected connection profile.
  2. Enter the new value only in the field that changed. Leave all other credential fields blank to preserve their stored values.
  3. Test the connection to confirm the new value is valid.
  4. Save the profile.

Scheduled jobs continue to pick up the updated credentials on their next execution. If a job is currently running, it uses the credentials that were active when that run started; the new credentials take effect on the following run.

  • Use a dedicated service account or integration-specific credential for each connection profile. Avoid reusing personal credentials.
  • Grant the minimum permissions needed for the integration in the source or target system.
  • Rotate credentials periodically, or immediately if you suspect a compromise.
  • Do not share the same API key or password across multiple environments (for example, do not use production credentials in a test profile).

To prevent a profile from being used without deleting it:

  1. Open the edit form for the profile.
  2. Uncheck the Active checkbox.
  3. Save.

Inactive profiles remain visible in the list but cannot be selected when creating or editing a job.

In the Connection Profiles list, click Delete on the row you want to remove. A confirmation dialog appears. Deletion is permanent.

ActionPlatform AdminUser
View connection profilesYesYes (own tenant only)
Create connection profileYesYes
Edit connection profileYesYes
Test connectionYesYes
Delete connection profileYesYes