Create a sync
This endpoint creates a sync.
Request parameters
Provider of the sync (e.g. ‘github”, ‘stripe”, etc). See the list of possible values.
The destination stream the sync should write to.
Name of the sync.
IDs of the collections to sync.
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.
Credential for the sync.
A credential is required to create a sync. You can either create a new credential or use an existing credential.
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.
Alternatively, you can use the credential_id (string) for an existing credential.
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.
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.
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.
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.
Response fields
ID of the sync.
Provider of the sync (e.g. github, stripe, etc). See the list of possible values.
ID of the stream the sync writes to.
ID of your organization.
Name of the sync, which you provide on create or update.
Whether the sync is active or disabled.
Health of the sync. Learn more about the health object.
IDs of the collections that are synced by this sync.
Rate limit of the sync. Learn more about the rate limit 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.
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.
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.
Timestamp of when the initial backfill was completed, in ISO 8601 format. Is null if the initial backfill has not yet completed.
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.
Timestamp of when the sync was created, in ISO 8601 format.
Timestamp of when the sync was last updated, in ISO 8601 format.
Was this page helpful?