Skip to main content
POST
/
api
/
syncs
Enable a Sync
curl --request POST \
  --url https://sync.useparagon.com/api/syncs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "integration": "googledrive",
  "pipeline": "files",
  "configuration": {},
  "configurationName": "<string>"
}'
{
  "id": "a11347bd-d510-5489-9068-e5fded55a28c",
  "userId": "your-user-id",
  "integration": "googledrive",
  "pipeline": "files",
  "projectId": "1ea8024c-23a7-4885-b925-c50d0faf9318",
  "status": "INITIALIZING"
}
Upon sending this request, the sync will immediately start with the account that the user has connected. After the initial sync has completed, you will receive a sync_completed webhook event and records created / updated after the initial sync will send record_created or record_updated webhook events. Learn more about the Sync Lifecycle.

Authorizations

​
Authorization
string
header
required

Body

application/json
​
integration
string
required
Example:
​
pipeline
string
required
Example:
​
configuration
object
​
configurationName
string

Response

​
id
string
required
Example:
​
userId
string
required
Example:
​
integration
string
required
Example:
​
pipeline
string
required
Example:
​
projectId
string
required
Example:
​
status
enum<string>
required
Available options:
INITIALIZING,
ACTIVE,
IDLE,
DISABLED,
ERRORED