Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt

Use this file to discover all available pages before exploring further.

Remote data is a feature exposing the raw, unchanged data that we receive from the APIs, allowing you to read data that might not be available in our unified API model. It is disabled by default because it has compliance implications (we need to store all data we receive, not just the data points selected in the scope configs) and because you will need to write parsing logic for each integration/tool. It is mainly used to read data that might not be available in our unified Data Models. Some customers are for example interested in some specific government-issued company IDs, which are currently not part of our Data Model, but can be extracted from these raw responses. An example response might be: 
{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "first_name": "John",
        "last_name": "Doe",
        ...
        "remote_data": {
          "EmployeeData": {
            "Names": {
              "FirstName": "John",
              "LastName": "Doe"
            },
            "Company": {
              "GovernmentID": "123456789"
            }
          }
        }
      }
    ]
  }
}
remote_data gives you the raw API response from the connected system. If you need structured extra fields for reading, see Custom Fields. If you need to write additional data when creating records, see Remote Fields.

​
When to use remote data

Remote data should be used when our unified Data Model does not offer specific fields that you are interested in. Note that we do not unify remote data, so the data structure might differ between tools and might even differ between individual integrations of the same tool.

​
When not to use remote data

Remote data might potentially expose sensitive data, even if your customers opt out of it. We might, for example, always receive personally identifiable information (e.g. emails, names and addresses). If your customers opt out of these data fields, we will discard this data and never store it. If remote data is active, however, we will expose the raw responses and therefore information that should optimally not be stored. We also offer custom fields, which are a more versatile and compliant variant of remote data.

​
How to use remote data

Remote data can be enabled on a per-model basis in the scope config. To enable it, please contact us.