Integration Add

Connect external platforms, CRMs, and ERP systems to Hyperfold.

Overview

The hyperfold integrate add command connects external systems to your Hyperfold project. Integrations enable bi-directional data synchronization, allowing agents to access customer data, product information, and order history from your existing business systems.

Integrations are essential for the Negotiator Agent to access customer context and for the Fulfillment Agent to process orders.

Usage

# Add an integration
$ hyperfold integrate add shopify

Configuring Shopify integration...

Please visit this URL to authorize Hyperfold:
https://your-store.myshopify.com/admin/oauth/authorize?...

Waiting for authorization...
✓ Authorization received

SHOPIFY CONNECTED
  Store:             your-store.myshopify.com
  Plan:              Shopify Plus
  Products:          2,847
  Orders (30d):      1,234

Syncing initial data...
✓ Products synced (2,847)
✓ Inventory synced
✓ Customer segments synced

Integration ready!

Supported Platforms

Platform	Type	Docs
Shopify	E-commerce	Setup Guide
Salesforce	CRM	Setup Guide
Stripe	Payments	Setup Guide
PayPal	Payments	Setup Guide
ShipStation	Fulfillment	Setup Guide
Custom API	Any REST/GraphQL	Data Mapping

Options

Option	Description
`--name`	Custom name for the integration
`--type`	Integration type (erp, crm, webhook, etc.)
`--endpoint`	API endpoint URL for custom integrations
`--auth-type`	Authentication type (oauth2, api_key, basic)
`--client-id`	OAuth client ID
`--client-secret`	OAuth client secret
`--api-key`	API key for key-based auth
`--events`	Webhook events to subscribe to

Examples

Salesforce CRM

# Add Salesforce CRM integration
$ hyperfold integrate add salesforce \
  --instance-url="https://acme.salesforce.com" \
  --client-id=xxx \
  --client-secret=xxx

Connecting to Salesforce...
✓ Connected

SALESFORCE CONNECTED
  Instance:          acme.salesforce.com
  Edition:           Enterprise
  Objects:           Contact, Account, Opportunity

Configure object sync? [Y/n] y

Select objects to sync:
[x] Contact (map to customers)
[x] Account (map to organizations)
[x] Opportunity (map to negotiations)
[ ] Lead
[ ] Case

✓ Object mappings created
✓ Bi-directional sync enabled

Custom ERP Integration

# Add ERP system integration
$ hyperfold integrate add custom \
  --name="SAP S/4HANA" \
  --type=erp \
  --endpoint="https://sap.acme.com/api" \
  --auth-type=oauth2 \
  --client-id=xxx \
  --client-secret=xxx

Testing connection...
✓ Connected to SAP S/4HANA

CUSTOM INTEGRATION CONFIGURED
  Name:              SAP S/4HANA
  Type:              ERP
  Endpoint:          https://sap.acme.com/api
  Auth:              OAuth 2.0

Available data sources:
  ✓ Materials (products)
  ✓ Business Partners (customers)
  ✓ Sales Orders
  ✓ Inventory
  ✓ Pricing Conditions

# Add webhook receiver for real-time updates
$ hyperfold integrate add custom \
  --name="Warehouse WMS" \
  --type=webhook \
  --events=inventory_update,shipment_status

Managing Integrations

# List all integrations
$ hyperfold integrate list

INTEGRATIONS

NAME              TYPE          STATUS     LAST SYNC        EVENTS (24h)
Shopify           e-commerce    active     2 min ago        1,247
Salesforce        crm           active     5 min ago        456
SAP S/4HANA       erp           active     1 hour ago       89
Stripe            payments      active     real-time        2,341
ShipStation       fulfillment   active     real-time        567

# Show integration details
$ hyperfold integrate show shopify

INTEGRATION: Shopify
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Type:               E-commerce Platform
Connected:          2025-01-15T10:00:00Z
Status:             active

SYNC STATUS
  Products:         2,847 / 2,847 (100%)
  Inventory:        Real-time webhooks
  Orders:           Bi-directional
  Customers:        Read-only

DATA MAPPINGS
  Products      →   Hyperfold Catalog
  Variants      →   Product Options
  Collections   →   Categories
  Customers     →   Customer Profiles
  Orders        →   Order History

WEBHOOKS
  ✓ products/create    → sync_product
  ✓ products/update    → sync_product
  ✓ orders/create      → new_order
  ✓ inventory_levels   → update_inventory

USAGE (30 days)
  API Calls:         45,678
  Webhook Events:    12,456
  Errors:            23 (0.05%)

Removing Integrations

# Remove an integration
$ hyperfold integrate remove salesforce

⚠ This will:
  - Stop all data synchronization
  - Remove stored credentials
  - Keep historical data in Hyperfold

Confirm removal? [y/N] y

✓ Salesforce integration removed
✓ Credentials deleted
✓ Webhooks unregistered

Historical data preserved. Use --purge to delete all synced data.

After adding an integration, configure data mappings to control how data flows between systems.

Search Documentation