Integration Data (Key-Value Store)

Integrations have access to a namespaced key-value store to which proprietary data can be written on any record of any entity

  • This field is always called integrationsData.{{integrationName}} where {{integrationsName}} is the name of the integration as set up in Account Settings

  • An integration can only write to its own namespace - any attempts to write to any other namespace will fail

  • You do not have to send the entire contents of the KV store for that integration when patching integrationsData.{{integrationName}}. For example, if you want to set the value of key1 to val1, you only need to send integrationsData.{{integrationName}}.key1: val1 - none of the other keys in the namespace will be affected

  • The key-value store is intended for writing identifiers, flags and other small pieces of data - it is not meant to be used as a fully-fledged database

  • An integration can write up to 20 keys per record

  • Maximum key size is 64 bytes

  • Maximum value size is 1024 bytes

Last updated