Skip to main content

Trigger external sync

Starts a background sync job against the configured external system. Returns 202 with a jobId immediately — poll /api/sync/external/{jobId} or /api/sync/status for progress. Returns 409 if a job is already in progress for the same config.

Request​

Method: POST
Path: /api/sync/external

Authentication: Not required

Request Body​

Content Type: application/json

Schema: See component schemas below

Responses​

202 - Job scheduled​

400 - Invalid payload​

404 - Tenant not found​

409 - Sync already in progress​

503 - Sync event store unavailable​

Examples​

cURL​

curl -X POST \
  -H "Content-Type: application/json" \
  http://localhost:3000/api/sync/external \
  -d '{"example": "data"}'

JavaScript​

const response = await fetch('http://localhost:3000/api/sync/external', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    // Request data
  }),
});

const data = await response.json();
console.log(data);

This documentation is automatically generated from the OpenAPI specification.