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 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.

Getting your API key
--------------------

There are two types of API keys:

*   **User-level API key**
    
*   **Workspace-level API key**
    

### User-level API key

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 >

Profile

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

Only one key per user can be generated.

### Workspace-level 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 >

Workspace settings

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

Several keys per workspace can be generated.

<Callout attributes='{"isFitToPage":true,"dataType":"info","style":{"width":"100%","minWidth":"100%"}}'>
  <p>You can identify if an API key is a User- or Workspace-level API key.</p>
  *   User-level API keys start with `user_`
*   Workspace-level API keys start with `workspace_`
</Callout>

Rate limiting
-------------

Max 10 requests per second are allowed per client.

Data processing regions
-----------------------

Data processing regions available (also referred as `region`):

*   Belgium (St. Guislain): `besg`
    
*   US (Northern Virginia): `usnv`

API Reference

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.

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. Can be filtered by connection name.

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).

`account_type` is only required for Salesforce apps.

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

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

Bases

Note that for BigQuery the table\_id should have the following format `project_id.dataset.table_name`. 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. **Sync Directions:** The `sync_direction` for the tables can have 3 possible values:

<Table style="width:100%;min-width:100%" colSizes='["initial","initial"]' isHeaderAdded='false' tableHeader='[{"id":"625b8e81-dd9d-4106-9929-5d16c0d9284a","title":"Title"},{"id":"a00b2c31-bd90-476d-8b50-e68feeb76fc2","title":"Description"}]'>
  <table-row>
    <table-cell><p class="slate-p ">Value</p></table-cell>
    <table-cell><p class="slate-p ">Description</p></table-cell>
  </table-row>
  <table-row>
    <table-cell><p class="slate-p ">bidirectional</p></table-cell>
    <table-cell><p class="slate-p ">Data can be read and written into the table.</p></table-cell>
  </table-row>
  <table-row>
    <table-cell><p class="slate-p ">incoming</p></table-cell>
    <table-cell><p class="slate-p ">Data can only be written into the table.</p></table-cell>
  </table-row>
  <table-row>
    <table-cell><p class="slate-p ">outgoing</p></table-cell>
    <table-cell><p class="slate-p ">Data can only be read from the table.</p></table-cell>
  </table-row>
</Table>

**Creating new tables:**

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.

<Table style="width:100%;min-width:100%" colSizes='["initial","initial","initial"]' isHeaderAdded='false' tableHeader='[{"id":"8bf2dba2-cf36-4cc0-8fe7-35fd94ce93b1","title":"Title"},{"id":"1e686e05-9175-4fc8-894b-26aa24212ed2","title":"Description"},{"id":"061f7fe1-806d-41e8-a21d-374958786cf9","title":"Title"}]'>
  <table-row>
    <table-cell><p class="slate-p ">App-1</p></table-cell>
    <table-cell><p class="slate-p ">App-2</p></table-cell>
    <table-cell><p class="slate-p ">Behaviour</p></table-cell>
  </table-row>
  <table-row>
    <table-cell><p class="slate-p ">FALSE</p></table-cell>
    <table-cell><p class="slate-p ">FALSE</p></table-cell>
    <table-cell><p class="slate-p ">Tables and columns to be mapped already exist on both apps.</p></table-cell>
  </table-row>
  <table-row>
    <table-cell><p class="slate-p ">FALSE</p></table-cell>
    <table-cell><p class="slate-p ">TRUE</p></table-cell>
    <table-cell><p class="slate-p ">Tables and columns to be mapped only exist on App-1, Stacksync will create a table on App-2.</p></table-cell>
  </table-row>
  <table-row>
    <table-cell><p class="slate-p ">TRUE</p></table-cell>
    <table-cell><p class="slate-p ">TRUE</p></table-cell>
    <table-cell><p class="slate-p ">Error, the table should exist in at least one App.</p></table-cell>
  </table-row>
</Table>

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):**

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. 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). 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.
    

**App options (optional):**

Additionally, the `app_options` parameter can be passed to the request body inside each `app` with the following fields:

*   `delete_protection` (optional), if set to true, `delete_protection` will be enabled, preventing the deletion of any records in the specified app.
    

**Custom primary key (optional):**

When Stacksync creates a new table (`“table_options”: {“create_new_table”: true}`), it adds a primary key column to the new table. By default, this column is named `stacksync_record_id_` and has the type `uuid`. To choose the name and data type of this column yourself, pass a `primary_key` parameter inside `table_options`:

<CodeBlock attributes='{"isFitToPage":true,"style":{},"lang":"json","label":"JSON"}'>
  <CodeLine>      "table_options": {</CodeLine>
  <CodeLine>          "create_new_table": true,</CodeLine>
  <CodeLine>          "primary_key": {</CodeLine>
  <CodeLine>              "column_name": "record_id",</CodeLine>
  <CodeLine>              "data_type": "text"</CodeLine>
  <CodeLine>          }</CodeLine>
  <CodeLine>      }</CodeLine>
</CodeBlock>

*   `column_name` (required), the name of the primary key column. Letters, numbers and underscores only, maximum 63 characters. The primary key column is created **in addition to** the columns being synced, so its name must not match any column of the new table otherwise the request is rejected with \`The primary key column name ‘’ collides with a column of the table ’
    

<Table style="width:100%;min-width:100%" colSizes='[]' isHeaderAdded='false' tableHeader='[]'>

</Table>

Create base

Generates the available schema for an existing connection, including table names, table IDs, primary-key information, and available columns.

This endpoint authenticates the supplied app credentials and retrieves the available schema from the connector.

Endpoint
--------

`POST /v1/workspaces/{workspace_id}/helpers/generate-app-schema?region={region}`

Generate app schema

The `Edit Base` endpoint allows users to modify an existing base by **providing a complete updated schema**. The payload format is identical to the responses from the `Create Base` and `Get Base` endpoints, allowing users to retrieve an existing base, apply modifications, and submit it via a `PUT` request to fully replace the base.

### Modifying existing tables:

*   **Add columns** New columns can be added to an existing table by including them in the table’s `columns` list. Each new column must have a matching column_mapping_id.
    
*   **Remove columns** To remove a column, simply omit it from the `columns` list in **both** of the tables. Any columns not included will be considered removed.
    
*   **Change the sync direction** The `sync_direction` field of a table can be updated to alter how data flows between systems (e.g., changing from `outgoing` to `incoming`, or to `bidirectional`). Both tables in a table mapping must maintain a valid sync relationship (e.g., `outgoing` ↔ `incoming` or `bidirectional` ↔ `bidirectional`).
    
*   **Remove a table** To remove an existing table, omit it from the `tables` list of **both** apps in the updated schema. If a table is missing from both sides, it will be treated as deleted.
    

### Adding new tables:

New tables can be added by including them in the `tables` list of both apps. The configuration format for new tables must follow the same structure as used in the `Create Base` API.

### Enable/Disable Delete Protection:

Setting `delete_protection` in `app_options` to `true` enables delete protection, while setting it to `false` disables it.

Edit base

Get base

Gets bases for a given workspace\_id.

All regions are scanned in this call.

Can be filtered by name

Get bases for a given workspace.

Get base status

Switch base on/off

Toggle `delete_protection` for an app in a base.

Enabling `delete_protection` prevents the deletion of any records in the specified app.

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](https://docs.stacksync.cloud/connectors/setup-options/manage-api-rate-limits)

Update the rate limit of an app

Delete base

<span style="color:color(srgb 0.337569 0.337569 0.337569)">Trigger some Webhook call or Database queries when some data events happen in your sync (e.g. a contact is created in your CRM).</span>

Triggers

Webhooks enable users to receive a POST request at a designated URL upon the occurrence of specific events related to their bases, such as errors or changes in base status.

Webhooks

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

Issues

Get issues

Take action on data sync issues, given a list of `issue_id`. The `action` parameters can have 2 possible values:

<Table style="width:100%;min-width:100%" colSizes='[]' isHeaderAdded='false' tableHeader='[]'>
  <table-row>
    <table-cell><p class="slate-p ">Value</p><div class="slate-div"><div class="slate-div"><div class="slate-div"><div class="slate-div"><p class="slate-p "></p></div></div></div><div class="slate-div"><p class="slate-p "></p></div></div><p class="slate-p "></p></table-cell>
    <table-cell><p class="slate-p ">Description</p><div class="slate-div"><div class="slate-div"><div class="slate-div"><div class="slate-div"><p class="slate-p "></p></div></div></div><div class="slate-div"><p class="slate-p "></p></div></div><p class="slate-p "></p></table-cell>
  </table-row>
  <table-row>
    <table-cell><p class="slate-p ">revert</p><div class="slate-div"><div class="slate-div"><div class="slate-div"><div class="slate-div"><p class="slate-p "></p></div></div></div><div class="slate-div"><p class="slate-p "></p></div></div><p class="slate-p "></p></table-cell>
    <table-cell><p class="slate-p ">Stacksync will automatically try to fix the error</p><div class="slate-div"><div class="slate-div"><div class="slate-div"><div class="slate-div"><p class="slate-p "></p></div></div></div><div class="slate-div"><p class="slate-p "></p></div></div><p class="slate-p "></p></table-cell>
  </table-row>
  <table-row>
    <table-cell><p class="slate-p ">ignore</p><div class="slate-div"><div class="slate-div"><div class="slate-div"><div class="slate-div"><p class="slate-p "></p></div></div></div><div class="slate-div"><p class="slate-p "></p></div></div><p class="slate-p "></p></table-cell>
    <table-cell><p class="slate-p ">Ignore the error.</p><div class="slate-div"><div class="slate-div"><div class="slate-div"><div class="slate-div"><p class="slate-p "></p></div></div></div><div class="slate-div"><p class="slate-p "></p></div></div><p class="slate-p "></p></table-cell>
  </table-row>
  <table-row>
    <table-cell><p class="slate-p ">retry</p><div class="slate-div"><div class="slate-div"><div class="slate-div"><div class="slate-div"><p class="slate-p "></p></div></div></div><div class="slate-div"><p class="slate-p "></p></div></div><p class="slate-p "></p></table-cell>
    <table-cell><p class="slate-p ">Retries to sync the row</p><div class="slate-div"><div class="slate-div"><div class="slate-div"><div class="slate-div"><p class="slate-p "></p></div></div></div><div class="slate-div"><p class="slate-p "></p></div></div><p class="slate-p "></p></table-cell>
  </table-row>
</Table>

Take action on issues

To receive real-time notifications when an issue occurs during sync, use the [Create Webhook](https://app.theneo.io/stacksync/api-v1/bases/webhooks/create-webhook) endpoint.

#### Request Instructions:

*   In the request body, set the `action` field to: `real_time_issue_notification`
    

This will subscribe your webhook to receive immediate updates whenever a sync issue happens.

#### Webhook Payload Example:

example of a webhook payload your server will receive when a sync issue occurs:

<CodeBlock attributes='{"isFitToPage":true,"style":{},"lang":"json","label":"JSON"}'>
  <CodeLine>      {</CodeLine>
  <CodeLine>      	"notification": {</CodeLine>
  <CodeLine>      		"created_time": "2025-03-24T18:47:56.110798",</CodeLine>
  <CodeLine>      		"notification_type": "real_time_issue_notification",</CodeLine>
  <CodeLine>      		"msg": "Some records had issues syncing on base: \"xxxxxxxx-xxxx-xxxx-xxx-xxxxxxxxxx\" for the app: \"xxxxxxx\", to view the issue(s) go to the issues tab in your workspace",</CodeLine>
  <CodeLine>      		"base_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",</CodeLine>
  <CodeLine>      		"internal_table_id": "xxxxxx",</CodeLine>
  <CodeLine>      		"app_id": "xxxxxx"</CodeLine>
  <CodeLine>      	}</CodeLine>
  <CodeLine>      }</CodeLine>
</CodeBlock>

/

Get informed upon issue

Workflows are Stacksync’s automation engine: event-driven sequences of modules (triggers, API calls, code, data operations) that run in your workspace. This section covers the public Workflows APIs.

Workflows

The Log Explorer API gives programmatic access to workflow execution logs: list and filter executions, read the detailed module-by-module logs of an execution, resolve or unresolve execution errors, and enumerate the workflows available in a workspace.

**Authentication**: pass a workspace API key or a user API key as a Bearer token in the `Authorization` header. Workspace keys act with editor permissions; user keys carry the user’s role in the workspace (resolving errors requires editor or above).

**Region**: every endpoint requires the `region` query parameter identifying the data processing region where the workflow runs (e.g. `besg`, `usnv`). You can read each workflow’s region from the _Get workflows tree_ endpoint.

**Base URL**: `https://api.stacksync.cloud`. Each endpoint’s path includes its API version (`/v1` or `/v2`).

**Errors**: validation failures return a 400 whose body names the offending field (`field`, dotted path), echoes the value you sent, and lists the allowed values or expected shape. Optional fields sent empty (`""` or `[]`) are treated as omitted rather than rejected.

**Sorting**: `options.sort` is `"desc"` (default) or `"asc"` by execution start time. (`direction` remains accepted as a deprecated alias.)

Log Explorer

The Workflow Configuration API gives read access to workflow definitions: enumerate the workflows of a workspace, and fetch the full configuration of a workflow — its modules with their properties, the edges wiring them together, timeouts and versions — as JSON.

**Authentication**: pass a workspace API key or a user API key as a Bearer token in the `Authorization` header.

**Region**: workflows live in a data processing region (e.g. `besg`, `usnv`). _Get workflow versions_ and _Get workflow info_ require the `region` query parameter; _List workflows_ and _Get workflow_ accept it optionally and search all regions when it is omitted — pass it whenever you know it, responses are faster. You can read each workflow’s region from _List workflows_ or the Log Explorer’s _Get workflows tree_.

**Versions**: a workflow has one draft version (`"0"`) and zero or more numbered versions; one version can be deployed. _Get workflow_ returns the latest version unless `version` is passed.

**Base URL**: `https://api.stacksync.cloud`.

Workflow Configuration

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

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. Can be filtered by name

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 are a collection of commonly used APIs designed to support building StackSync applications.

Helpers

The **Get App Schema** section of the StackSync API enables users to retrieve schema information for a specific application, providing insights into the application’s structure and data requirements.

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;</p><p class="slate-p " >Profile</p><p class="slate-p " >&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;</p><p class="slate-p " >Workspace settings</p><p class="slate-p " >&gt; Stacksync API &gt; (Re-)Generate API key.</p><p class="slate-p " >Several keys per workspace can be generated.</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><h2 class="slate-h2 " >Rate limiting</h2><p class="slate-p " >Max 10 requests per second are allowed per client.</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>

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 >

Several keys per workspace can be generated.

Max 10 requests per second are allowed per client.

Data processing regions available (also referred as 

Manage your Stacksync workspace, bases, sync configurations and more from the API. Companies use Stacksync to offer native integration between their…

<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>

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

<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 " >Note that for BigQuery the table_id should have the following format <code class="slate-code">project_id.dataset.table_name</code>. The <code class="slate-code">table_mapping_id</code> and <code class="slate-code">column_mapping_id</code> 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. <strong class="slate-bold">Sync Directions:</strong> The <code class="slate-code">sync_direction</code> for the tables can have 3 possible values:</p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div >Title</div><div >Description</div></div><table class="slate-table" style="min-width:100%;"><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >Value</p></td><td class="slate-td"><p class="slate-p " >Description</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >bidirectional</p></td><td class="slate-td"><p class="slate-p " >Data can be read and written into the table.</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >incoming</p></td><td class="slate-td"><p class="slate-p " >Data can only be written into the table.</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >outgoing</p></td><td class="slate-td"><p class="slate-p " >Data can only be read from the table.</p></td></tr></tbody></table></div></div><p class="slate-p " ><strong class="slate-bold">Creating new tables:</strong></p><p class="slate-p " >If <code class="slate-code">&quot;table_options&quot;: {&quot;create_new_table&quot;: true}</code>, Stacksync will create a new table on the app, based on the schema of the other table to be synced.</p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div >Title</div><div >Description</div><div >Title</div></div><table class="slate-table" style="min-width:100%;"><colgroup ><col style="width:initial"><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >App-1</p></td><td class="slate-td"><p class="slate-p " >App-2</p></td><td class="slate-td"><p class="slate-p " >Behaviour</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >FALSE</p></td><td class="slate-td"><p class="slate-p " >FALSE</p></td><td class="slate-td"><p class="slate-p " >Tables and columns to be mapped already exist on both apps.</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >FALSE</p></td><td class="slate-td"><p class="slate-p " >TRUE</p></td><td class="slate-td"><p class="slate-p " >Tables and columns to be mapped only exist on App-1, Stacksync will create a table on App-2.</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >TRUE</p></td><td class="slate-td"><p class="slate-p " >TRUE</p></td><td class="slate-td"><p class="slate-p " >Error, the table should exist in at least one App.</p></td></tr></tbody></table></div></div><p class="slate-p " >If App-1 is <code class="slate-code">FALSE</code> and App-2 is <code class="slate-code">TRUE</code>, Stacksync will create a table on App-2.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">If no columns are indicated in the mapping, all columns of App-1 will be created in App-2.</div></li><li class="slate-li " ><div style="position:relative">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.</div></li><li class="slate-li " ><div style="position:relative">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.</div></li></ul><p class="slate-p " ><strong class="slate-bold">Rate limits (optional):</strong></p><p class="slate-p " >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. Rate limiting is optional, it is recommended NOT to edit it. If the <code class="slate-code">rate_limit</code> parameter is absent from the schema, it will be set to default (recommended). Via the API, the rate is always defined per second:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">frequency</code>, in seconds, is always 1 (i.e. one second).</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">rate</code>, API calls/requests per period. Minimum value is 4.</div></li></ul><p class="slate-p " ><strong class="slate-bold">App options (optional):</strong></p><p class="slate-p " >Additionally, the <code class="slate-code">app_options</code> parameter can be passed to the request body inside each <code class="slate-code">app</code> with the following fields:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">delete_protection</code> (optional), if set to true, <code class="slate-code">delete_protection</code> will be enabled, preventing the deletion of any records in the specified app.</div></li></ul><p class="slate-p " ><strong class="slate-bold">Custom primary key (optional):</strong></p><p class="slate-p " >When Stacksync creates a new table (<code class="slate-code">“table_options”: {“create_new_table”: true}</code>), it adds a primary key column to the new table. By default, this column is named <code class="slate-code">stacksync_record_id_</code> and has the type <code class="slate-code">uuid</code>. To choose the name and data type of this column yourself, pass a <code class="slate-code">primary_key</code> parameter inside <code class="slate-code">table_options</code>:</p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">        &quot;table_options&quot;: {
</div><div class="slate-code_line">            &quot;create_new_table&quot;: true,
</div><div class="slate-code_line">            &quot;primary_key&quot;: {
</div><div class="slate-code_line">                &quot;column_name&quot;: &quot;record_id&quot;,
</div><div class="slate-code_line">                &quot;data_type&quot;: &quot;text&quot;
</div><div class="slate-code_line">            }
</div><div class="slate-code_line">        }
</div></code></pre></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">column_name</code> (required), the name of the primary key column. Letters, numbers and underscores only, maximum 63 characters. The primary key column is created <strong class="slate-bold">in addition to</strong> the columns being synced, so its name must not match any column of the new table otherwise the request is rejected with `The primary key column name ‘’ collides with a column of the table ’</div></li></ul><div class="published-table"><div class="table-container" style="padding-left: 0px;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"></div><table class="slate-table" style="min-width:100%;"><colgroup ></colgroup><tbody class="slate-TableElement-tbody"></tbody></table></div></div>

Note that for BigQuery the table_id should have the following format 

 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. 

 for the tables can have 3 possible values:

Title

Description

"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.

, Stacksync will create a table on App-2.

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. Rate limiting is optional, it is recommended NOT to edit it. If the 

 parameter is absent from the schema, it will be set to default (recommended). Via the API, the rate is always defined per second:

 parameter can be passed to the request body inside each 

“table_options”: {“create_new_table”: true}

), it adds a primary key column to the new table. By default, this column is named 

. To choose the name and data type of this column yourself, pass a 

base_name

base_region

apps

Authorization

workspace_id

base_id

base_status

Note that for BigQuery the tableid should have the following format projectid.dataset.tablename . The tablemappingid and columnmappingid are…

<p class="slate-p " >Generates the available schema for an existing connection, including table names, table IDs, primary-key information, and available columns.</p><p class="slate-p " >This endpoint authenticates the supplied app credentials and retrieves the available schema from the connector.</p><h2 class="slate-h2 " >Endpoint</h2><p class="slate-p " ><code class="slate-code">POST /v1/workspaces/{workspace_id}/helpers/generate-app-schema?region={region}</code></p>

Generates the available schema for an existing connection, including table names, table IDs, primary-key information, and available columns.

This endpoint authenticates the supplied app credentials and retrieves the available schema from the connector.

POST /v1/workspaces/{workspace_id}/helpers/generate-app-schema?region={region}

connection_id

table_names must contain the exact table names/IDs returned by the schema. The response still includes the full table list, but columns is populated only for the requested tables.

If table_names is omitted or empty, the endpoint returns tables without column metadata.

table_names

Bearer authentication token. Example: Bearer {token}

Content-Type

region

app_type

tables

error

Generates the available schema for an existing connection, including table names, table IDs, primary-key information, and available columns. This…

<p class="slate-p " >The <code class="slate-code">Edit Base</code> endpoint allows users to modify an existing base by <strong class="slate-bold">providing a complete updated schema</strong>. The payload format is identical to the responses from the <code class="slate-code">Create Base</code> and <code class="slate-code">Get Base</code> endpoints, allowing users to retrieve an existing base, apply modifications, and submit it via a <code class="slate-code">PUT</code> request to fully replace the base.</p><h3 class="slate-h3 " >Modifying existing tables:</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Add columns</strong> New columns can be added to an existing table by including them in the table’s <code class="slate-code">columns</code> list. Each new column must have a matching column<em class="slate-italic">mapping</em>id.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Remove columns</strong> To remove a column, simply omit it from the <code class="slate-code">columns</code> list in <strong class="slate-bold">both</strong> of the tables. Any columns not included will be considered removed.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Change the sync direction</strong> The <code class="slate-code">sync_direction</code> field of a table can be updated to alter how data flows between systems (e.g., changing from <code class="slate-code">outgoing</code> to <code class="slate-code">incoming</code>, or to <code class="slate-code">bidirectional</code>). Both tables in a table mapping must maintain a valid sync relationship (e.g., <code class="slate-code">outgoing</code> ↔ <code class="slate-code">incoming</code> or <code class="slate-code">bidirectional</code> ↔ <code class="slate-code">bidirectional</code>).</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Remove a table</strong> To remove an existing table, omit it from the <code class="slate-code">tables</code> list of <strong class="slate-bold">both</strong> apps in the updated schema. If a table is missing from both sides, it will be treated as deleted.</div></li></ul><h3 class="slate-h3 " >Adding new tables:</h3><p class="slate-p " >New tables can be added by including them in the <code class="slate-code">tables</code> list of both apps. The configuration format for new tables must follow the same structure as used in the <code class="slate-code">Create Base</code> API.</p><h3 class="slate-h3 " >Enable/Disable Delete Protection:</h3><p class="slate-p " >Setting <code class="slate-code">delete_protection</code> in <code class="slate-code">app_options</code> to <code class="slate-code">true</code> enables delete protection, while setting it to <code class="slate-code">false</code> disables it.</p>

 endpoint allows users to modify an existing base by 

. The payload format is identical to the responses from the 

 endpoints, allowing users to retrieve an existing base, apply modifications, and submit it via a 

New tables can be added by including them in the 

 list of both apps. The configuration format for new tables must follow the same structure as used in the 

 enables delete protection, while setting it to 

The Edit Base endpoint allows users to modify an existing base by providing a complete updated schema . The payload format is identical to the…

name

data

<p class="slate-p " >Gets bases for a given workspace_id.</p><p class="slate-p " >All regions are scanned in this call.</p><p class="slate-p " >Can be filtered by name</p>

Gets bases for a given workspace_id. All regions are scanned in this call. Can be filtered by name

switch_mode

<p class="slate-p " >Toggle <code class="slate-code">delete_protection</code> for an app in a base.</p><p class="slate-p " >Enabling <code class="slate-code">delete_protection</code> prevents the deletion of any records in the specified app.</p>

 prevents the deletion of any records in the specified app.

action

app_id

Toggle deleteprotection for an app in a base. Enabling deleteprotection prevents the deletion of any records in the specified app.

<p class="slate-p " >Update the name of a specific base within a workspace. Currently, this endpoint only allows updating the <code class="slate-code">base_name</code>. Future updates will enable modifying the <code class="slate-code">base_schema</code>.</p>

Update the name of a specific base within a workspace. Currently, this endpoint only allows updating the 

. Future updates will enable modifying the 

message

Update the name of a specific base within a workspace. Currently, this endpoint only allows updating the basename . Future updates will enable…

<p class="slate-p " >Update the API rate limit of an app in a given base. The rate is in requests per seconds (i.e ‘frequency’=1)</p><p class="slate-p " >The rate should be minimum 4 requests per second, there is no maximum.</p><p class="slate-p " >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 <a href="https://docs.stacksync.cloud/connectors/setup-options/manage-api-rate-limits" target="_self">https://docs.stacksync.cloud/connectors/setup-options/manage-api-rate-limits</a></p>

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 

rate

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…

<p class="slate-p " ><span class="slate-color" style="color:color(srgb 0.337569 0.337569 0.337569)">Trigger some Webhook call or Database queries when some data events happen in your sync (e.g. a contact is created in your CRM).</span></p>

Trigger some Webhook call or Database queries when some data events happen in your sync (e.g. a contact is created in your CRM).

<p class="slate-p " >Webhooks enable users to receive a POST request at a designated URL upon the occurrence of specific events related to their bases, such as errors or changes in base status.</p>

Webhooks enable users to receive a POST request at a designated URL upon the occurrence of specific events related to their bases, such as errors or…

<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 " >Workflows are Stacksync’s automation engine: event-driven sequences of modules (triggers, API calls, code, data operations) that run in your workspace. This section covers the public Workflows APIs.</p>

Workflows are Stacksync’s automation engine: event-driven sequences of modules (triggers, API calls, code, data operations) that run in your…

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

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

Sections