#18. REST API / External Integration
iSyncSF exposes REST and SOAP API endpoints for external integration. The DataSyncReceiver REST endpoint on the target org accepts incoming sync payloads, while the SOAP-based ISyncSFWebService interface enables external systems to programmatically trigger syncs and query job status.
Purpose: The REST/SOAP API endpoints serve two roles: (1) The DataSyncReceiver endpoint runs on the target org and receives incoming sync data from the source org - it is the communication channel that makes the sync work, and (2) The migration service endpoints allow external systems to programmatically trigger sync jobs and check their status, enabling CI/CD pipelines, scheduled integrations, or custom tooling to automate sync operations. Where It Fits: The DataSyncReceiver is internal plumbing - it's always active and users don't interact with it directly. The migration service endpoints are used by external systems or automation scripts that want to trigger syncs without using the UI. This enables scenarios like "automatically sync data after every deployment" or "trigger sync from a CI/CD pipeline".
#18.1 Available Endpoints
The application exposes REST and SOAP endpoints for external integration:
| Endpoint | Purpose |
|---|---|
| DataSyncReceiver (REST) | Primary endpoint on the target org that receives sync data, handles file transfers, and metadata queries |
| IsyncSFDataMigrateService (REST) | Remotely triggers a migration job on the destination org |
| IsyncSFDataMigrateStatusService (REST) | Queries migration job status by job ID |
| ISyncSFWebService (SOAP) | SOAP alternative for triggering migration and checking status |
#18.2 External API Access
- Can be enabled via the "Enable External API" system property
- Allows external systems to trigger and monitor sync jobs programmatically