Skip to main content

Zip Setup Guide

Prerequisites

  • An active Zip account with API access.

Note: If you do not have API access in your Zip account, reach out to Zip Support Team to request API access

Setup Guide

Step 1: Obtain API Key from Zip

  1. Sign in to your Zip account.
  2. Click the settings icon in the top right corner, and choose Company Settings.
  3. On the navigation menu, go to Setup -> API.
  4. Go to the API Keys tab.
  5. Click + Create API Key and select Restricted.
  6. Enter a descriptive name like Matia-Integration.
  7. In the drop-down menu, select Read Only for every type of record you want to sync and click Create.
  8. Save the API Token - you will need it to configure your connection.

Step 2: Find your Zip Environment

  1. In your Zip account, click the question mark icon in the top right corner, and choose API Documentation. find api documentation
  2. Go to the documentation for any endpoint and make a note of its Base URL. The base URLs are in the https://<environment>.ziphq.com/<endpoint_name> format. find environment in base URL
  3. Find your environment in the base URL and make a note of it. For example, if the base URL is https://test.ziphq.com/approvals, then your environment is test.

Step 3: Complete Configuration in Matia

  1. Enter the API Key you generated and the Environment from your Zip account.
  2. Enter an Asset Name.
  3. (Optional) Enter a Description.
  4. (Optional) Assign Tags.
  5. Select an Owner.
  6. Verify that your Zip account is successfully connected by clicking on Test Connection.
  7. Click Connect.