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>"
}'

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

Paragon User Token. Add to the Authorization header of your requests.

Body

application/json

Response

200

Sync successfully enabled