Skip to main content
To sync data models from Honeydew to Sigma, Honeydew connects to the Sigma REST API. The API uses client credentials (a Client ID and a Client secret) for authentication. This builds on the Honeydew connection in Sigma.

​
API Access Setup

1

Create API credentials in Sigma

  1. Sign in to Sigma as an administrator.
  2. Go to Administration → Developer Access.
  3. Click Create New to open the Create client credentials dialog.
  4. Under Select scopes, enable REST API.
  5. Fill in the remaining fields:
    • Name — a descriptive name (for example Honeydew)
    • Description — optional
    • Owner — the Sigma user the credentials act as
    The owner assigned to the credential must have permission to create and update data models in the target workspace, and must have access to the Honeydew connection in Sigma.
  6. Click Create, then copy the Client ID and Client secret. The secret is shown only once.
  7. Note your Sigma API base URL (for example https://aws-api.sigmacomputing.com). The base URL depends on the cloud and region of your Sigma organization — see Sigma’s API documentation for the value that matches your organization.
2

Configure Honeydew with the credentials

  1. Sign in to Honeydew with a user that has administrator privileges.
  2. Open the user settings menu.
  3. Navigate to Sigma → Settings.
  4. Enter the following information:
    • Base URL — your Sigma API base URL (for example https://aws-api.sigmacomputing.com)
    • Client ID — the client ID generated in the previous step
    • Client secret — the client secret generated in the previous step
Once API access is set up, you can publish a Honeydew domain to Sigma as a data model. See Publishing a domain as a data model for the steps, and Sigma-specific Metadata for field formatting.