Integration Patterns

VibeIQ provides multiple patterns for integrating with external systems. Choose the approach that best fits your use case and technical requirements.

• Authentication & API Access

  ---

  Learn how to authenticate and access the VibeIQ API using SDKs or REST

  Authentication Guide

• Assortment Publish Integration

  ---

  Event-driven integration that pushes Assortment publish events to your system in real-time

  Assortment Publish Guide

• Change History Polling

  ---

  Pull-based integration that polls for entity changes within a specified time range

  Change History Guide

Choosing an Integration Pattern: Polling vs Event-Driven

Aspect	Change History Polling	Assortment Publish Events
Trigger	Time-based (scheduled)	Event-based (on publish)
Latency	Minutes to hours	Near real-time
Complexity	Simple to implement	Requires webhook endpoint
Control	Full control over timing	Reactive to events
Use Case	Batch sync, reporting	Real-time integration
Entity Coverage	All entity types	Assortment-specific
Historical Data	Easy to retrieve	Requires separate API calls

When to use polling:

• You need batch synchronization on a schedule
• You want to track changes across multiple entity types
• You need to retrieve historical changes
• Your system doesn't support webhooks

When to use event-driven:

• You need near real-time synchronization
• You're specifically tracking Assortment publishes
• You want to minimize API calls
• Your system can receive webhooks

Event-Driven (Push)

Best for:

• Real-time synchronization requirements
• Assortment-specific workflows
• Systems that can receive webhooks
• Minimizing API calls

Patterns:

• Assortment Publish Integration

Pull-Based (Polling)

Best for:

• Batch synchronization on a schedule
• Tracking multiple entity types
• Historical data retrieval
• Systems without webhook support

Patterns:

• Change History Polling

Getting Started

1. Review Authentication & API Access - Set up your API credentials and understand authentication methods
2. Choose your integration pattern - Select event-driven or pull-based based on your requirements
3. Follow the pattern guide - Implement the integration using the detailed documentation
4. Test your integration - Verify data flows correctly between systems
5. Monitor and optimize - Track performance and adjust as needed