Start sync(s)

Start a sync

curl --request POST \
  --url https://api.nango.dev/sync/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider_config_key": "<string>",
  "syncs": [
    "github-issues"
  ],
  "connection_id": "<string>"
}
'

import requests

url = "https://api.nango.dev/sync/start"

payload = {
    "provider_config_key": "<string>",
    "syncs": ["github-issues"],
    "connection_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    provider_config_key: '<string>',
    syncs: ['github-issues'],
    connection_id: '<string>'
  })
};

fetch('https://api.nango.dev/sync/start', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nango.dev/sync/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'provider_config_key' => '<string>',
    'syncs' => [
        'github-issues'
    ],
    'connection_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nango.dev/sync/start"

	payload := strings.NewReader("{\n  \"provider_config_key\": \"<string>\",\n  \"syncs\": [\n    \"github-issues\"\n  ],\n  \"connection_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nango.dev/sync/start")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider_config_key\": \"<string>\",\n  \"syncs\": [\n    \"github-issues\"\n  ],\n  \"connection_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nango.dev/sync/start")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider_config_key\": \"<string>\",\n  \"syncs\": [\n    \"github-issues\"\n  ],\n  \"connection_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true
}

{
  "message": "<string>"
}

POST

sync

start

Start a sync

curl --request POST \
  --url https://api.nango.dev/sync/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider_config_key": "<string>",
  "syncs": [
    "github-issues"
  ],
  "connection_id": "<string>"
}
'

import requests

url = "https://api.nango.dev/sync/start"

payload = {
    "provider_config_key": "<string>",
    "syncs": ["github-issues"],
    "connection_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    provider_config_key: '<string>',
    syncs: ['github-issues'],
    connection_id: '<string>'
  })
};

fetch('https://api.nango.dev/sync/start', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nango.dev/sync/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'provider_config_key' => '<string>',
    'syncs' => [
        'github-issues'
    ],
    'connection_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nango.dev/sync/start"

	payload := strings.NewReader("{\n  \"provider_config_key\": \"<string>\",\n  \"syncs\": [\n    \"github-issues\"\n  ],\n  \"connection_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nango.dev/sync/start")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider_config_key\": \"<string>\",\n  \"syncs\": [\n    \"github-issues\"\n  ],\n  \"connection_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nango.dev/sync/start")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider_config_key\": \"<string>\",\n  \"syncs\": [\n    \"github-issues\"\n  ],\n  \"connection_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true
}

{
  "message": "<string>"
}

Requires an API key with the environment:syncs:execute scope. Learn more about API key scopes.

Authorizations

Authorization

string

header

required

An Environment API key from your Nango environment, or an Account API key for account-level endpoints.

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 start. If empty, all syncs are triggered

Sync name

connection_id

string

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

Response

Successfully started the sync

success

boolean

required

Getting started

Guides

Reference

Authorizations

Body

Response