Skip to main content
POST
/
sync
/
trigger
Trigger a sync
curl --request POST \
  --url https://api.nango.dev/sync/trigger \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider_config_key": "<string>",
  "syncs": [
    "github-issues"
  ],
  "connection_id": "<string>",
  "sync_mode": "incremental",
  "full_resync": true
}
'
{
  "success": true
}

​
Triggering one-off syncs

This is especially useful if you e.g. changed the metadata for the connection and now want to re-import data.

Authorizations

​
Authorization
string
header
required

The secret key from your Nango environment.

Body

application/json
​
provider_config_key
string
required

The ID of the integration that you established within Nango.

​
syncs
required

A list of sync names that you wish to pause. If empty, all syncs are triggered

Sync name

​
connection_id
string

The ID of the connection. If omitted, the syncs will be triggered for all relevant connections.

​
sync_mode
enum<string>

The mode in which to trigger the syncs.

  • incremental: Triggers a new sync job while preserving the "lastSyncDate".
  • full_refresh: Resets the "lastSyncDate" associated with the sync before triggering a new sync job.
  • full_refresh_and_clear_cache: Resets the "lastSyncDate" and deletes all records associated with the sync before triggering a new sync job.
Available options:
incremental,
full_refresh,
full_refresh_and_clear_cache
​
full_resync
boolean
deprecated

Reset the "lastSyncDate" associated with the sync before triggering a new sync job.

Response

Successfully triggered the sync

​
success
boolean
required