Create a sync - Sequin

curl --request POST \
  --url https://api.sequin.io/v1/syncs \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "provider": "stripe",
    "stream_id": "f0f70b52-5243-489c-879b-a1ae3f02abfd",
    "name": "Choam Corp - Stripe Production",
    "collection_ids": ["stripe:customer", "stripe:invoice"],
    "rate_limit": {
      "allowed_requests": 100,
      "interval": 60,
      "max_concurrent_requests": 0
    },
    "credential": {
      "properties": {
        "kind": "stripe_oauth2",
        "secret": "sk_live_7eC39HqLyjWDarjtT1zdp7dc",
        "test": true,
        "name": "Choam Corp - Stripe [Test]"
      },
      "oauth_app_id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8",
      "metadata": { "custom_credential_property": 42 }
    },
    "metadata": { "custom_property": 42 },
    "external_id": "{YOUR_EXTERNAL_ID}"
  }'

curl --request POST \
  --url https://api.sequin.io/v1/syncs \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "provider": "stripe",
    "name": "Choam Corp - Stripe Production",
    "collection_ids": ["stripe:customer", "stripe:invoice"],
    "rate_limit": {
      "allowed_requests": 100,
      "interval": 60,
      "max_concurrent_requests": 0
    },
    "credential_id": "45763c5a-0a34-4808-843e-7d406ab910f1",
    "metadata": { "custom_property": 42 },
    "external_id": "{YOUR_EXTERNAL_ID}"
  }'

{
  "id": "c906b4a4-0cda-4f46-bd80-255f570c195d",
  "provider": "stripe",
  "stream_id": "f0f70b52-5243-489c-879b-a1ae3f02abfd",
  "name": "Choam Corp - HubSpot Production",
  "status": "active",
  "org_id": "75958cea-c981-4116-9a0d-c1e99e826688",
  "health": {
    "status": "healthy",
    "sync_id": "c906b4a4-0cda-4f46-bd80-255f570c195d"
  },
  "collection_ids": ["hubspot:contact", "hubspot:company"],
  "rate_limit": {
    "allowed_requests": 1000,
    "interval": 60,
    "max_concurrent_requests": 0
  },
  "credential_id": "27879937-bd5d-490b-a943-edf486b04300",
  "credential": {
    "id": "27879937-bd5d-490b-a943-edf486b04300",
    "provider": "stripe",
    "properties": {
      "kind": "stripe_key",
      "name": "TEST ACCOUNT",
      "secret": "***********",
      "test": true
    },
    "oauth_app_id": null,
    "oauth_app": {
      "kind": "sequin"
    },
    "metadata": { "custom_credential_property": 42 },
    "created_at": "2023-12-15 01:29:29",
    "updated_at": "2023-12-15 01:29:29"
  },
  "max_age_days": 365,
  "sync_frequency": "continuous",
  "initial_backfill_completed_at": "2023-12-15 01:29:29",
  "metadata": { "custom_property": 42 },
  "created_at": "2023-12-15 01:29:29",
  "updated_at": "2023-12-15 01:29:29"
}

POST

syncs

curl --request POST \
  --url https://api.sequin.io/v1/syncs \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "provider": "stripe",
    "stream_id": "f0f70b52-5243-489c-879b-a1ae3f02abfd",
    "name": "Choam Corp - Stripe Production",
    "collection_ids": ["stripe:customer", "stripe:invoice"],
    "rate_limit": {
      "allowed_requests": 100,
      "interval": 60,
      "max_concurrent_requests": 0
    },
    "credential": {
      "properties": {
        "kind": "stripe_oauth2",
        "secret": "sk_live_7eC39HqLyjWDarjtT1zdp7dc",
        "test": true,
        "name": "Choam Corp - Stripe [Test]"
      },
      "oauth_app_id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8",
      "metadata": { "custom_credential_property": 42 }
    },
    "metadata": { "custom_property": 42 },
    "external_id": "{YOUR_EXTERNAL_ID}"
  }'

curl --request POST \
  --url https://api.sequin.io/v1/syncs \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "provider": "stripe",
    "name": "Choam Corp - Stripe Production",
    "collection_ids": ["stripe:customer", "stripe:invoice"],
    "rate_limit": {
      "allowed_requests": 100,
      "interval": 60,
      "max_concurrent_requests": 0
    },
    "credential_id": "45763c5a-0a34-4808-843e-7d406ab910f1",
    "metadata": { "custom_property": 42 },
    "external_id": "{YOUR_EXTERNAL_ID}"
  }'

{
  "id": "c906b4a4-0cda-4f46-bd80-255f570c195d",
  "provider": "stripe",
  "stream_id": "f0f70b52-5243-489c-879b-a1ae3f02abfd",
  "name": "Choam Corp - HubSpot Production",
  "status": "active",
  "org_id": "75958cea-c981-4116-9a0d-c1e99e826688",
  "health": {
    "status": "healthy",
    "sync_id": "c906b4a4-0cda-4f46-bd80-255f570c195d"
  },
  "collection_ids": ["hubspot:contact", "hubspot:company"],
  "rate_limit": {
    "allowed_requests": 1000,
    "interval": 60,
    "max_concurrent_requests": 0
  },
  "credential_id": "27879937-bd5d-490b-a943-edf486b04300",
  "credential": {
    "id": "27879937-bd5d-490b-a943-edf486b04300",
    "provider": "stripe",
    "properties": {
      "kind": "stripe_key",
      "name": "TEST ACCOUNT",
      "secret": "***********",
      "test": true
    },
    "oauth_app_id": null,
    "oauth_app": {
      "kind": "sequin"
    },
    "metadata": { "custom_credential_property": 42 },
    "created_at": "2023-12-15 01:29:29",
    "updated_at": "2023-12-15 01:29:29"
  },
  "max_age_days": 365,
  "sync_frequency": "continuous",
  "initial_backfill_completed_at": "2023-12-15 01:29:29",
  "metadata": { "custom_property": 42 },
  "created_at": "2023-12-15 01:29:29",
  "updated_at": "2023-12-15 01:29:29"
}

Request parameters

string

required

Provider of the sync (e.g. ‘github”, ‘stripe”, etc). See the list of possible values.

string

required

The destination stream the sync should write to.

string

required

Name of the sync.

array

required

IDs of the collections to sync.

object

Rate limit of the sync. Learn more about the rate limit object. The rate limit object is not required if you’re using Sequin OAuth for certain providers. If you don’t specify a rate limit, Sequin will use a reasonable default according to your provider.

object

required

Credential for the sync.

Hide credential

A credential is required to create a sync. You can either create a new credential or use an existing credential.

object

Credential for the sync. This will usually consist of an access token and a refresh token Sequin uses to make requests. This object is polymorphic, see the list of possible shapes.

string

Alternatively, you can use the credential_id (string) for an existing credential.

number

By default, Sequin syncs all data from the API regardless of age. When you set max_age_days, Sequin will only sync and retain records that have been created or updated in the last max_age_days days.Defaults to null, which means no age limit.

string

One of continuous or 4h. If continuous, Sequin will run a continuous sync to sync data as fast as possible from the API. If 4h, Sequin will sync data every 4 hours.

object

Metadata for the sync. This is a JSON object that you can use to store any additional information you want to associate with the sync.

string

External ID for the sync. This is a string that you can use to associate the sync with an entity in your system. For example, you can set this to your system’s user_id or org_id associated with the sync.

curl --request POST \
  --url https://api.sequin.io/v1/syncs \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "provider": "stripe",
    "stream_id": "f0f70b52-5243-489c-879b-a1ae3f02abfd",
    "name": "Choam Corp - Stripe Production",
    "collection_ids": ["stripe:customer", "stripe:invoice"],
    "rate_limit": {
      "allowed_requests": 100,
      "interval": 60,
      "max_concurrent_requests": 0
    },
    "credential": {
      "properties": {
        "kind": "stripe_oauth2",
        "secret": "sk_live_7eC39HqLyjWDarjtT1zdp7dc",
        "test": true,
        "name": "Choam Corp - Stripe [Test]"
      },
      "oauth_app_id": "8ff58ef0-d376-4ae8-b2e2-9f0206aa65b8",
      "metadata": { "custom_credential_property": 42 }
    },
    "metadata": { "custom_property": 42 },
    "external_id": "{YOUR_EXTERNAL_ID}"
  }'

curl --request POST \
  --url https://api.sequin.io/v1/syncs \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "provider": "stripe",
    "name": "Choam Corp - Stripe Production",
    "collection_ids": ["stripe:customer", "stripe:invoice"],
    "rate_limit": {
      "allowed_requests": 100,
      "interval": 60,
      "max_concurrent_requests": 0
    },
    "credential_id": "45763c5a-0a34-4808-843e-7d406ab910f1",
    "metadata": { "custom_property": 42 },
    "external_id": "{YOUR_EXTERNAL_ID}"
  }'

Response fields

{
  "id": "c906b4a4-0cda-4f46-bd80-255f570c195d",
  "provider": "stripe",
  "stream_id": "f0f70b52-5243-489c-879b-a1ae3f02abfd",
  "name": "Choam Corp - HubSpot Production",
  "status": "active",
  "org_id": "75958cea-c981-4116-9a0d-c1e99e826688",
  "health": {
    "status": "healthy",
    "sync_id": "c906b4a4-0cda-4f46-bd80-255f570c195d"
  },
  "collection_ids": ["hubspot:contact", "hubspot:company"],
  "rate_limit": {
    "allowed_requests": 1000,
    "interval": 60,
    "max_concurrent_requests": 0
  },
  "credential_id": "27879937-bd5d-490b-a943-edf486b04300",
  "credential": {
    "id": "27879937-bd5d-490b-a943-edf486b04300",
    "provider": "stripe",
    "properties": {
      "kind": "stripe_key",
      "name": "TEST ACCOUNT",
      "secret": "***********",
      "test": true
    },
    "oauth_app_id": null,
    "oauth_app": {
      "kind": "sequin"
    },
    "metadata": { "custom_credential_property": 42 },
    "created_at": "2023-12-15 01:29:29",
    "updated_at": "2023-12-15 01:29:29"
  },
  "max_age_days": 365,
  "sync_frequency": "continuous",
  "initial_backfill_completed_at": "2023-12-15 01:29:29",
  "metadata": { "custom_property": 42 },
  "created_at": "2023-12-15 01:29:29",
  "updated_at": "2023-12-15 01:29:29"
}

string

ID of the sync.

string

Provider of the sync (e.g. github, stripe, etc). See the list of possible values.

string

ID of the stream the sync writes to.

string

ID of your organization.

string

Name of the sync, which you provide on create or update.

string

Whether the sync is active or disabled.

object

Health of the sync. Learn more about the health object.

array

IDs of the collections that are synced by this sync.

object

Rate limit of the sync. Learn more about the rate limit object.

object

Credential for the sync. This will usually consist of an access token and a refresh token Sequin uses to make requests. This object is polymorphic, see the list of possible shapes.

number

string

One of continuous or 4h. If continuous, Sequin will run a continuous sync to sync data as fast as possible from the API. If 4h, Sequin will sync data every 4 hours.

string

Timestamp of when the initial backfill was completed, in ISO 8601 format. Is null if the initial backfill has not yet completed.

object

Metadata for the sync. This is a JSON object that you can use to store any additional information you want to associate with the sync.

string

Timestamp of when the sync was created, in ISO 8601 format.

string

Timestamp of when the sync was last updated, in ISO 8601 format.

​Request parameters

​Response fields

Request parameters

Response fields