Understanding the Platform
APIWORX uses a few key concepts you'll encounter throughout the platform.
Connectors
Connections to external systems like Shopify, NetSuite, QuickBooks, and more. Each stores authentication credentials and configuration for a specific platform instance. Connectors can be sources, destinations, or bidirectional.
Flows
Define how data moves between connectors. A flow specifies the source, destination, object type, field mappings, filters, and trigger mechanism — webhook, scheduled, or manual.
Events
Individual data payloads entering the system. Each event is uniquely identified to ensure idempotency — no duplicate processing. Events are tracked through the full pipeline.
Jobs
Execution units that process events through pipeline stages: Ingest → Normalize → Transform → Deliver. Jobs track status, duration, retry attempts, and detailed logs.
Quick Start Guide
Follow these steps to set up your first integration. Most users have their first flow running in under 15 minutes.
Connect Your First System
Navigate to Connectors, click 'Add Connector', select your source system (e.g., Shopify), and enter your API credentials.
Add a Destination
Add another connector for where you want data to flow — an ERP, CRM, data warehouse, or custom REST endpoint.
Create an Integration Flow
Select source and destination connectors, choose the object type (orders, customers, etc.), and configure field mappings.
Test and Activate
Use manual trigger to test with sample data. Once verified, activate to start processing live data via webhooks or schedules.
Monitor Your Integration
Use the Dashboard, Events, and Jobs pages to monitor. Set up alert rules to get notified of any issues.
Pro Tip: Start with your Development environment to test integrations safely. Once everything is working, promote your connectors and flows to Production.
Documentation Topics
Dive deeper into each area of the platform.
Connectors
Learn how to create, configure, test, and manage connector instances. Covers authentication, environment promotion, and health checks.
- E-commerce, ERP, CRM & custom connectors
- OAuth, API key & token authentication
- Environment-specific isolation
- Connection health monitoring
Integration Flows
Build flows with the visual flow builder. Configure field mappings, transformations, filters, and trigger mechanisms.
- Webhook, scheduled & manual triggers
- AI-powered field auto-mapping
- Direct, format, concat, lookup & custom transforms
- Flow versioning and status management
Events & Jobs
Understand the processing pipeline, monitor job execution, handle failures with automatic and manual retry, and debug with detailed logs.
- Ingest → Normalize → Transform → Deliver pipeline
- Idempotency via External Event ID
- Automatic retry with configurable policies
- Detailed execution logs per job
Data Repository
Explore the unified data repository with normalized entities from all connected systems. Search, filter, and export your integration data.
- Customers, orders, products & inventory
- Unified schema across all sources
- Powerful search and filtering
- CSV export and analytics charts
Environments
Use isolated environments for development, testing, and production. Promote connectors and flows between environments safely.
- Dev, Test, Production & Demo environments
- Complete resource isolation
- Promote configurations across environments
- Environment-specific API keys
Alerts & Monitoring
Configure proactive monitoring with failure thresholds, connector health checks, latency alerts, and custom rules.
- Failure rate threshold alerts
- Connector health monitoring
- Latency threshold detection
- Email notifications with cooldown
Webhooks
Enable real-time synchronization with webhook endpoints. Each connector gets a unique URL with signing secrets and HTTPS encryption.
- Unique webhook URL per connector
- Signing secret validation
- HTTPS encryption in transit
- Environment-specific isolation
REST API
Full programmatic access to all platform features. Build custom integrations, automate workflows, or create white-label solutions.
- Bearer token authentication
- Scoped API keys
- CRUD for connectors, flows, events & jobs
- Interactive API Explorer available