Integrations API
Connect and manage external platforms, payment providers, and fulfillment services.
Overview
The Integrations API allows you to programmatically connect external services, manage data synchronization, and monitor webhook deliveries.
| Integration Type | Examples |
|---|---|
| E-commerce | Shopify, WooCommerce, BigCommerce |
| Payments | Stripe, PayPal, Checkout.com |
| Fulfillment | ShipStation, Shippo |
| CRM | Salesforce, HubSpot |
List Integrations
bash
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# GET /v1/integrations# List all integrations curl -X GET https://api.hyperfold.io/v1/integrations \ -H "Authorization: Bearer hf_live_xxx" \ -H "X-Project-ID: proj_acme" # Response{ "data": [ { "id": "int_shopify_001", "type": "shopify", "name": "Acme Shopify Store", "status": "connected", "config": { "store_domain": "acme.myshopify.com", "sync_products": true, "sync_orders": true, "sync_customers": true }, "last_sync": "2025-01-20T10:00:00Z", "metrics": { "products_synced": 2847, "orders_synced": 4521, "errors_24h": 3 } }, { "id": "int_stripe_001", "type": "stripe", "name": "Stripe Payments", "status": "connected", "config": { "account_id": "acct_xxx", "live_mode": true } } ]} # GET /v1/integrations/:id# Get integration details curl -X GET https://api.hyperfold.io/v1/integrations/int_shopify_001 \ -H "Authorization: Bearer hf_live_xxx"Connect
bash
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# POST /v1/integrations/connect# Initiate OAuth connection curl -X POST https://api.hyperfold.io/v1/integrations/connect \ -H "Authorization: Bearer hf_live_xxx" \ -H "X-Project-ID: proj_acme" \ -H "Content-Type: application/json" \ -d '{ "type": "shopify", "redirect_uri": "https://yourapp.com/oauth/callback" }' # Response{ "authorization_url": "https://acme.myshopify.com/admin/oauth/authorize?...", "state": "state_xyz789", "expires_in": 600} # POST /v1/integrations/connect/complete# Complete OAuth flow curl -X POST https://api.hyperfold.io/v1/integrations/connect/complete \ -H "Authorization: Bearer hf_live_xxx" \ -H "X-Project-ID: proj_acme" \ -H "Content-Type: application/json" \ -d '{ "type": "shopify", "code": "auth_code_from_callback", "state": "state_xyz789" }' # Response{ "id": "int_shopify_001", "type": "shopify", "status": "connected", "store_domain": "acme.myshopify.com"} # POST /v1/integrations/connect/api-key# Connect with API key (non-OAuth) curl -X POST https://api.hyperfold.io/v1/integrations/connect/api-key \ -H "Authorization: Bearer hf_live_xxx" \ -H "X-Project-ID: proj_acme" \ -H "Content-Type: application/json" \ -d '{ "type": "shipstation", "credentials": { "api_key": "xxx", "api_secret": "xxx" }, "name": "ShipStation Fulfillment" }'Connection Methods
| Method | Integrations |
|---|---|
| OAuth 2.0 | Shopify, Salesforce |
| API Key | Stripe, ShipStation, Shippo |
| Custom | REST endpoints, webhooks |
Data Sync
bash
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# POST /v1/integrations/:id/sync# Trigger manual sync curl -X POST https://api.hyperfold.io/v1/integrations/int_shopify_001/sync \ -H "Authorization: Bearer hf_live_xxx" \ -H "Content-Type: application/json" \ -d '{ "resources": ["products", "inventory"], "full_sync": false }' # Response{ "sync_id": "sync_abc123", "status": "running", "resources": ["products", "inventory"], "started_at": "2025-01-20T10:00:00Z"} # GET /v1/integrations/:id/sync/:sync_id# Check sync status curl -X GET https://api.hyperfold.io/v1/integrations/int_shopify_001/sync/sync_abc123 \ -H "Authorization: Bearer hf_live_xxx" # Response{ "sync_id": "sync_abc123", "status": "completed", "resources": { "products": { "total": 2847, "created": 12, "updated": 156, "errors": 0 }, "inventory": { "total": 8541, "updated": 234, "errors": 2 } }, "duration_ms": 45000, "completed_at": "2025-01-20T10:00:45Z"} # GET /v1/integrations/:id/sync/history# Get sync history curl -X GET "https://api.hyperfold.io/v1/integrations/int_shopify_001/sync/history?limit=10" \ -H "Authorization: Bearer hf_live_xxx"Webhooks
bash
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# GET /v1/integrations/:id/webhooks# List webhooks for integration curl -X GET https://api.hyperfold.io/v1/integrations/int_shopify_001/webhooks \ -H "Authorization: Bearer hf_live_xxx" # Response{ "data": [ { "id": "wh_abc123", "topic": "products/update", "endpoint": "https://api.hyperfold.io/webhooks/shopify/xxx", "status": "active", "created_at": "2025-01-15T10:00:00Z" }, { "id": "wh_def456", "topic": "orders/create", "endpoint": "https://api.hyperfold.io/webhooks/shopify/xxx", "status": "active" } ]} # POST /v1/integrations/:id/webhooks# Register new webhook curl -X POST https://api.hyperfold.io/v1/integrations/int_shopify_001/webhooks \ -H "Authorization: Bearer hf_live_xxx" \ -H "Content-Type: application/json" \ -d '{ "topic": "inventory_levels/update", "actions": ["sync_inventory"] }' # GET /v1/integrations/:id/webhooks/logs# View webhook delivery logs curl -X GET "https://api.hyperfold.io/v1/integrations/int_shopify_001/webhooks/logs?\since=1h&\status=failed" \ -H "Authorization: Bearer hf_live_xxx" # Response{ "data": [ { "id": "whlog_xyz", "webhook_id": "wh_abc123", "topic": "products/update", "status": "failed", "error": "Timeout after 30s", "retry_count": 2, "payload_size": 4521, "received_at": "2025-01-20T09:55:00Z" } ]}Failed webhooks are automatically retried with exponential backoff. After 5 failed attempts, the webhook is marked as failed and requires manual intervention.
Learn about the buyer-facing API at ACP Discovery.