Zip

This guide will walk you through setting up a new connection to your ZipHQ account in Relyance. This configuration is an example use case of both Vendor Discovery and Contract Discovery, allowing the user to choose vendors to discover based on the vendor statuses mapped and their associated “final” contracts (DPAs and MSAs) only for those vendors whose statuses were mapped.

Part 1: Navigate to the ZipHQ Integration

• From the Relyance dashboard, navigate to Settings (the gear icon).
• On the left-hand menu, under "Platform Configurations," click Integrations.
• In the search bar, type "ZipHQ" and click on the ZipHQ integration card to open its connections page.

Part 2: Create a New Connection

• On the ZipHQ "Connections" page, click the + Add Connection button in the top-right corner.
• A pop-up modal will appear. Enter a clear, descriptive name for this specific workflow (e.g., "ZipHQ Connection: Vendor & Contract Discovery").
• Click Add.

Part 3: Configure the Connection Scope

This is a critical step where you define what data this connection will pull from ZipHQ.

• You will land on the "Overview" (Step 1) of the connection setup.
• In this example of both Vendor & Contract Discovery, the "Connection Options" section, ensure both of the following boxes are checked along with others if you wish to:
  • Contract Discovery
  • Vendor Discovery
• Scroll to the bottom and click Continue.

Part 4: Connection Settings

• On the "Connection Settings" (Step 2) page, you can set the "Rescan Frequency." The default is 1day. You can adjust this now or leave the default.
• Click Continue.

Part 5: Configure Vendor & Contract Status (New Feature)

This is the new configuration page that is essential for your production setup. It allows you to control WHICH vendors and contracts are synced.

• You are now on the "Vendor and Contract configuration" (Step 3) page.
• Please read the new information box at the top of the page. As stated you can choose to discover the type of vendor basis whatever statuses you map and the “final” contracts (DPAs and MSAs) will be populated only for vendors whose statuses are mapped and also these documents should be associated with a request in ZipHQ.
• Scroll down to the "Vendor Status Mapping Configuration" section. This table controls how a vendor's status in ZipHQ (left column) maps to its status in Relyance (right column).
• Here you can Click + Add mapping to manually map statuses or select the prefilled ones and edit them as well. Review this list carefully.
  • Note: If your goal is to only sync vendors who are "Active" in ZipHQ, you must not select / delete all other suggested rows (like "Initial > Onboarding", "Banned > Terminated", "Inactive > Terminated", etc.).
• Once you have configured the mappings to match your business rules, click Continue.

Part 6: Authenticate with ZipHQ

In this step, you will generate an API key in ZipHQ and paste it into Relyance.

In Your ZipHQ Account

• Open a new browser tab and log in to your production ZipHQ account.
• Click on your profile icon (top-right) and select Settings.
• On the left-hand menu, navigate to API (under the "Setup" section).
• Click the Create API key button and select Standard.
• Give your API key a descriptive name (e.g., "Relyance Production Integration") and click Create.
• A "Save API key" modal will appear. Click the copy icon to copy the token. This key will not be shown again, so save it securely if needed.

In the Relyance AI application:

1. Login to your Relyance AI account.
2. Navigate to the Settings (bottom-left corner).
3. Select Integrations.
4. Search and locate the Zip integration card and click on it.
5. Click on the Add Connection button on the top right.
6. Provide a meaningful name for the integration and click on the Add button.
7. In the Overview section, select the integration features you wish to enable for the integration, review the Scope and Permission, and Endpoint details and click on Continue. For more details, see Integration Features.

8. In the Connection section, provide the appropriate values and click on Continue,

• Connection Name: This property allows you to update the integration specified in Step 6. If you have multiple integrations for the same vendor, you may want to assign distinct names to each. This helps streamline filtering by Discovery Source across the Inventory, Visual Maps, Assets, and Data Flow Analysis pages.
• Rescan Frequency: This property allows you to configure how often Relyance executes scans against this Vendor connection.

Business Atlas Associations (required): the business entities or products that newly discovered third parties, services and assets from this integration are attributed to. Choose at least one from the Select Associations dropdown — the wizard will not advance past this step without one. For more details, see Business Atlas.

9. In the Authentication section, Please choose the authentication method as Custom and provide the following information retrieved from the In Zip section and click on Continue.

10. In the Data Inspection section, provide the appropriate values and click on Continue,

Minimum Confidence Level: This property adjusts the sensitivity of the Data Inspection feature. Lower likelihoods (e.g.,Very Low) offer more coverage but may produce false positives, while higher sensitivity (e.g., very High) provides greater accuracy but less coverage.

11. Review the configuration summary from the Completion section and click on Finish.

12. Confirm the integration Status reflects Connected.

Manage this integration with Terraform

Connections for this integration can be managed as code with the Relyance Terraform provider. Non-secret fields go in auth.params; secret fields go in auth.secrets_wo, which is write-only — never stored in Terraform state. Rotate secrets by bumping auth.secrets_wo_version.

resource "relyance_integration_connection" "ziphq" {
  vendor = "ziphq"
  name   = "<your connection name>"

  auth = {
    method = "api-key"
    params = {
      data_storage_location = "us"
    }
    # Secret fields are write-only: sent to Relyance, never stored in state.
    secrets_wo = {
      api_key = var.ziphq_api_key
    }
    secrets_wo_version = 1
  }

  scans = { "data-inspection" = { enabled = true } }
}