Skip to content

Deploy Packages

Ship entity definitions, permissions, webhooks, and seed data between environments as a single versioned ZIP. This page matches the marketing documentation for Enterprise package deployment.

Overview

  • Entity packages let you export a coherent set of configuration and data from one EntiHub deployment and import it into another.
  • Export includes selected entities, optional permissions, webhooks, and seed JSON.
  • Import deploys those artifacts into the target warehouse and configuration store in a controlled, logged sequence.
  • Package operations require the Enterprise tier and Global Admin access.

Package contents

MyOrg-mdm-package.zip
├── EntiHub-package.json
├── entities/
│   ├── Customer.yaml
│   └── Region.yaml
├── permissions.yaml
├── webhooks.yaml
└── seed/
    └── Region.json

Included files:

  • EntiHub-package.json — manifest with version, checksums, and export metadata.
  • entities/*.yaml — entity definitions.
  • permissions.yaml — optional permissions export.
  • webhooks.yaml — optional webhook subscriptions.
  • seed/*.json — optional seed data.

Export

POST /api/v1/packages/export
{
  "entityNames": ["Customer", "Region"],
  "autoIncludeDependencies": true,
  "includePermissions": true,
  "includeWebhooks": true,
  "includeSeed": false
}

Options:

  • autoIncludeDependencies
  • includePermissions
  • includeWebhooks
  • includeSeed

Deploy (import)

Upload a previously exported ZIP through the UI or as multipart/form-data with file field file:

POST /api/v1/packages/deploy

Common options:

  • overwriteExisting
  • importPermissions
  • importWebhooks
  • importSeed

The response includes a success flag, the list of deployed entities, and a detailed step-by-step log.

CI/CD workflow

  1. Finalize entities in development and export a package.
  2. Store the ZIP in Git or an artifact repository.
  3. Deploy the same artifact to staging, run smoke tests, then promote it to production.

CLI examples:

entihub packages export --file export-options.json
entihub packages deploy --file ./build/mdm-package.zip --overwrite-existing --import-permissions --import-webhooks

Important notes

  • The target environment must support the same Enterprise capabilities as the source.
  • Dependencies are resolved and applied in safe order.
  • Seed import should be reviewed carefully before production use.
  • Always review the deploy log in non-production before promotion.