Integrations API
Manage external service connections, field mappings, and data syncs.
3 min read
Integrations API
Manage external service connections, configure field mappings, and trigger data synchronization between WISEROWS and third-party services.
List Integrations
GET /api/v1/integrations
Returns all integrations configured for the current project.
Response
dataIntegration[]
Array of integration objects.
data[].idstring
Unique integration identifier.
data[].typestring
Integration type (e.g., `"sanity"`, `"google_search_console"`, `"posthog"`, `"loops"`).
data[].namestring
Human-readable display name for the integration.
data[].statusstring
Current status: `"active"`, `"inactive"`, `"error"`, or `"pending"`.
data[].lastSyncAtnumber | null
Unix timestamp (ms) of the last successful sync, or `null` if never synced.
Get Integration Details
GET /api/v1/integrations/{id}
Retrieve full details for a specific integration, including configuration and field mappings.
Note
This endpoint requires **admin** permission on the project.
Path Parameters
idstringrequired
The integration ID.
Response
data.idstring
Unique integration identifier.
data.typestring
Integration type.
data.namestring
Display name.
data.statusstring
Current status.
data.configobject
Provider-specific configuration (e.g., dataset name, project ID, API endpoint).
data.fieldMappingsFieldMapping[]
Array of field mapping objects defining how data flows between systems.
data.fieldMappings[].sourcestring
Source field path in WISEROWS (e.g., `"fields.title"`).
data.fieldMappings[].targetstring
Target field path in the external service (e.g., `"title"`).
data.fieldMappings[].transformstring | null
Optional transform to apply: `"uppercase"`, `"lowercase"`, `"slugify"`, `"markdown_to_html"`, or `null`.
data.lastSyncAtnumber | null
Unix timestamp (ms) of the last successful sync.
Trigger Sync
POST /api/v1/integrations/{id}/sync
Start a synchronization job for the given integration. Returns a job ID that you can use to track progress.
Path Parameters
idstringrequired
The integration ID.
Request Body
directionstring
Sync direction: `"pull"` (import from external service) or `"push"` (export to external service).
entityIdsstring[]
Optional array of specific entity IDs to sync. When omitted, all entities in the mapped entity types are synced.
Response
data.jobIdstring
Job ID for tracking sync progress via the Jobs API.
Tip
Use selective `entityIds` to push only recently changed entities instead of triggering a full sync. This is faster and reduces API calls to the external service.
Test Connection
POST /api/v1/integrations/{id}/test
Test whether the integration can connect to the external service with the current configuration.
Path Parameters
idstringrequired
The integration ID.
Response
data.connectedboolean
Whether the connection was successful.
data.latencyMsnumber
Round-trip latency to the external service in milliseconds.
Warning
If `connected` is `false`, verify your integration credentials in **Settings > Integrations** before retrying.
Was this helpful?