Stacksync

Manage your Stacksync workspace, bases, sync configurations and more from the API.

Companies use Stacksync to offer native integration between their own software and their clients’s CRM/Databases.

Stacksync enables them to access their clients’ CRM data in a generic manner and without having to deal with CRM API complexities. Companies can integrate a multitude of CRMs and Databases from a single generic data interface. Stacksync streamlines CRM integration for software vendors willing to reduce the development time, costs and maintenance needed to offer real-time CRM/Database integrations to their clients. Stacksync considerably reduces frontend and backend code complexity for software vendors with its out-of-the-box integrations. Stacksync also provides scalability solutions for CRM integrations.

API key: to get your API key, go to Stacksync > Profile > Stacksync API > (Re-)Generate my API key.

API rate limits: Max 10 requests per second are allowed per client.

Data processing regions available (also referred as `region`):
- Belgium (St. Guislain): `besg`
- US (Northern Virginia): `usnv`

API Reference

Connections

Create a new connection. Is only accessible to the user that creates the object (not accessible to the other users of the workspace by default).
The `service_type` is by default `managed_service` but can be `yourcompany_hosted` if a different app is used. Contact Stacksync for more info on how to have a custom app.

Create connection

Get a connection from a workspace in a specific region.


Get connection

Get all connections for a workspace in a specific region.


Get connections

Update a connection.

Body parameters:
  - connection_name (optional, updates the connection name if passed)
  - credentials (optional, updates the connection credentials if passed)
  - is_shared_with_workspace (optional, to make the connection available to the other 'editors' of the workspace)


Update connection

Delete a connection from a given workspace in a specific region.

A connection cannot be deleted if it is used in a service such as a base or an api prox service.


Delete connection

Validates a connection and replaces the credential in the associated connection if the validation is a success. Also makes sure that the credentials are valid for a given `base_id` and `app_id`.

Does not guarantee that the credentials are valid for the other bases or services associated with the connection (see the re-authorize base endpoint instead).


Re-authorize a connection and validates it for a given app

Bases

Note that for BigQuery the table_id should have the following format `project_id.dataset.table_name`. &lt;br>&lt;br>
The `table_mapping_id` and `column_mapping_id` are user-generated UUIDs chosen at random. They serve to specify which objects (either tables or columns) from each of the applications should synchronize together. Each mapping should consist of a matching pair of UUIDs, meaning there should be a same UUID associated with each application's objects. It is important to note that UUIDs cannot be reused across different mappings; therefore, each mapping must possess a distinct UUID. &lt;br>&lt;br>
**Sync Directions:** &lt;br>&lt;br>
The `sync_direction` for the tables can have 3 possible values:
| Value | Description |
| ----- | ----- |
| bidirectional | Data can be read and written into the table. |
| incoming | Data can only be written into the table.  |
| outgoing  | Data can only be read from the table.  |
**Creating new tables:** &lt;br>&lt;br>
If `"table_options": {
    "create_new_table": true
  }`, Stacksync will create a new table on the app, based on the schema of the other table to be synced.
| App-1 | App-2 | Behaviour |
| ----- | ----- | --------- |
| FALSE | FALSE | Tables and columns to be mapped already exist on both apps. |
| FALSE | TRUE  | Tables and columns to be mapped only exist on App-1, Stacksync will create a table on App-2. |
| TRUE  | TRUE  | Error, the table should exist in at least one App. |

If App-1 is `FALSE` and App-2 is `TRUE`, Stacksync will create a table on App-2.
- If no columns are indicated in the mapping, all columns of App-1 will be created in App-2.
- If some columns are indicated in the mapping in the schema of App-1 but not in the schema of App-2, only these columns will be created in App-2 with the same column names as in App-1.
- If some columns are indicated in the mapping in the schema of App-1 and in the schema of App-2, only these columns will be created in App-2. The table created in App-2 will have the custom column names indicated in the App-2 schema by the user.

**Rate limits (optional):** &lt;br>&lt;br>
The maximum number of API calls/Requests per seconds that Stacksync will make to your app at peak times. So the product docs to learn more. &lt;br>&lt;br>
Rate limiting is optional, it is recommended NOT to edit it. If the `rate_limit` parameter is absent from the schema, it will be set to default (recommended). &lt;br>&lt;br>
Via the API, the rate is always defined per second:
- `frequency`, in seconds, is always 1 (i.e. one second).
- `rate`, API calls/requests per period. Minimum value is 4.


Create base

Edit base

Get base

Gets all bases for a given workspace_id.

All regions are scanned in this call.


Get bases for a given workspace.

Get base status

Switch base on/off

Toggle delete protection on/off

Update the name of a specific base within a workspace. Currently, this endpoint only allows updating the `base_name`. Future updates will enable modifying the `base_schema`.


Update base name

Update the API rate limit of an app in a given base.
The rate is in requests per seconds (i.e 'frequency'=1)

The rate should be minimum 4 requests per second, there is no maximum.

To update the rate limit of an app within a base, the base does not need to be switched off. You can leave it on.
More informations on the rate limiting at https://docs.stacksync.cloud/connectors/setup-options/manage-api-rate-limits 

Update the rate limit of an app

Delete base

Triggers

Webhooks

Issues

Get issues

Take action on data sync issues, given a list of `issue_id`.
The `action` parameters can have 2 possible values:
| Value | Description |
| ----- | ----- |
| revert | Stacksync will automatically try to fix the error |
| ignore | Ignore the error.  |


Take action on issues

Get informed upon issue

API Proxy

Creates a new API Proxy service for a specified workspace and connection in a specific region.

The API proxy name is optional and will be generated randomly if not provided.


Create api proxy service

Retrieves details of a specific API Proxy service using its api_proxy_id.


Get api proxy service

Retrieves a list of all API Proxy services for a given workspace and region.


Get all api proxy services for a given workspace

Update api proxy

Regenerates a new API proxy token for a given api_proxy_id. The old token will be invalidated. Updates might take up to a minute to propagate to the entire system.

Regenerate api proxy token

Deletes a specific API Proxy service using its api_proxy_id for a given workspace and region.


Delete api proxy service

Helpers

Get App Schema

Stacksync API

Stacksync API V1

Manage your Stacksync workspace, bases, sync configurations and more from the API.  Companies use Stacksync to offer native integration between their own software and their clients’s CRM/Databases.  Stacksync enables you to access your clients’ CRM data in a generic manner and without having to deal with CRM API complexities. Companies can now integrate a multitude of CRMs and Databases from a single generic data interface. Stacksync streamlines CRM integration for software vendors willing to reduce the development time, costs and maintenance needed to offer real-time CRM/Database integrations to their clients. Stacksync considerably reduces frontend and backend code complexity for software vendors with its out-of-the-box integrations. Stacksync also provides scalability solutions for CRM integrations.

Stacksync Public API

Production V1

<p class="slate-p " >Manage your Stacksync workspace, bases, sync configurations and more from the API.</p><p class="slate-p " >Companies use Stacksync to offer native integration between their own software and their clients’s CRM/Databases.</p><p class="slate-p " >Stacksync enables you to access your clients’ CRM data in a generic manner and without having to deal with CRM API complexities. Companies can now integrate a multitude of CRMs and Databases from a single generic data interface. Stacksync streamlines CRM integration for software vendors willing to reduce the development time, costs and maintenance needed to offer real-time CRM/Database integrations to their clients. Stacksync considerably reduces frontend and backend code complexity for software vendors with its out-of-the-box integrations. Stacksync also provides scalability solutions for CRM integrations.</p><h2 class="slate-h2 " >Getting your API key</h2><p class="slate-p " >There are two types of API keys:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">User-level API key</strong></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Workspace-level API key</strong></div></li></ul><h3 class="slate-h3 " >User-level API key</h3><p class="slate-p " >Inherits a specific user access rights. Can be generated by every user themself. </p><p class="slate-p " >Has access to all workspaces that a user can access.</p><p class="slate-p " >To generate a user-level API key: Go to Stacksync &gt; <u class="slate-underline">Profile</u> &gt; Stacksync API &gt; (Re-)Generate my API key.</p><p class="slate-p " >Only one key per user can be generated.</p><h3 class="slate-h3 " >Workspace-level API key</h3><p class="slate-p " >Has access to all resources of the workspace with Editor access rights, independently of the owner of the resource. Can be generated only by workspace owners.</p><p class="slate-p " >Has access to a specific workspace only. All actions performed with a workspace level API key are considered performed as the workspace owner, but only inherit Editor access rights. For example, when creating a Base with a workspace level API key, the Base will result “created by” the current workspace owner. However, the workspace level API key does not allow to perform Owner-only actions such as deleting a workspace. A workspace level API key only inherits Editor access rights.</p><p class="slate-p " >To generate a workspace-level API key: Go to Stacksync &gt; <u class="slate-underline">Workspace settings</u> &gt; Stacksync API &gt; (Re-)Generate API key.</p><p class="slate-p " >Several keys per workspace can be generated.</p><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >You can identify if an API key is a User- or Workspace-level API key.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">User-level API keys start with <code class="slate-code">user_</code></div></li><li class="slate-li " ><div style="position:relative">Workspace-level API keys start with <code class="slate-code">workspace_</code></div></li></ul></div></div><p class="slate-p " ></p><h2 class="slate-h2 " >Rate limiting</h2><p class="slate-p " >Max 10 requests per second are allowed per client.</p><p class="slate-p " ></p><h2 class="slate-h2 " >Data processing regions</h2><p class="slate-p " >Data processing regions available (also referred as <code class="slate-code">region</code>):</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Belgium (St. Guislain): <code class="slate-code">besg</code></div></li><li class="slate-li " ><div style="position:relative">US (Northern Virginia): <code class="slate-code">usnv</code></div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

Manage your Stacksync workspace, bases, sync configurations and more from the API.

Companies use Stacksync to offer native integration between their own software and their clients’s CRM/Databases.

Stacksync enables you to access your clients’ CRM data in a generic manner and without having to deal with CRM API complexities. Companies can now integrate a multitude of CRMs and Databases from a single generic data interface. Stacksync streamlines CRM integration for software vendors willing to reduce the development time, costs and maintenance needed to offer real-time CRM/Database integrations to their clients. Stacksync considerably reduces frontend and backend code complexity for software vendors with its out-of-the-box integrations. Stacksync also provides scalability solutions for CRM integrations.

Inherits a specific user access rights. Can be generated by every user themself. 

Has access to all workspaces that a user can access.

To generate a user-level API key: Go to Stacksync > 

 > Stacksync API > (Re-)Generate my API key.

Has access to all resources of the workspace with Editor access rights, independently of the owner of the resource. Can be generated only by workspace owners.

Has access to a specific workspace only. All actions performed with a workspace level API key are considered performed as the workspace owner, but only inherit Editor access rights. For example, when creating a Base with a workspace level API key, the Base will result “created by” the current workspace owner. However, the workspace level API key does not allow to perform Owner-only actions such as deleting a workspace. A workspace level API key only inherits Editor access rights.

To generate a workspace-level API key: Go to Stacksync > 

 > Stacksync API > (Re-)Generate API key.

Several keys per workspace can be generated.

Max 10 requests per second are allowed per client.

Data processing regions available (also referred as 

<p class="slate-p " >Connections are objects enabling Stacksync to connect to an external App, such as a CRM or a Database. They contains the credentials necessary to access your App.</p><p class="slate-p " ></p>

Connections are objects enabling Stacksync to connect to an external App, such as a CRM or a Database. They contains the credentials necessary to access your App.

<p class="slate-p " >Bases are a data sync between two Apps, e.g. a two-way sync between Salesforce and Postgres.</p><p class="slate-p " ></p>

Bases are a data sync between two Apps, e.g. a two-way sync between Salesforce and Postgres.

<p class="slate-p " >When data is syncing, some issues might happen (e.g. an email wrongly formatted that cannot be written into an App).</p><p class="slate-p " ></p><p class="slate-p " ></p>

When data is syncing, some issues might happen (e.g. an email wrongly formatted that cannot be written into an App).

<p class="slate-p " >API Proxies are simplified APIs for CRMs such as Salesforce, Hubspot and more.</p><p class="slate-p " ></p><p class="slate-p " ></p>

API Proxies are simplified APIs for CRMs such as Salesforce, Hubspot and more.

<p class="slate-p " >Helpers are a collection of commonly used APIs designed to support building StackSync applications.</p><p class="slate-p " ></p>

Helpers are a collection of commonly used APIs designed to support building StackSync applications.

Sections