Skip to main content

Initial Value

How to use the sourceConfigInitialValues in the connector spec​

If you want to prepopulate a field in the connector spec configuration with an initial value, you can use the sourceConfigInitialValues field in the connector spec to specify the prepopulated value. This can be used across all items. All you need to provide is the item's key and its corresponding default value. This is a simple example using a textbox:

"sourceConfigInitialValues": {
    // Note that the key `airtableURL` is also the key of the item the initial value is provided for
    "airtableURL": "https://api.airtable.example.com/v0"
},
"sourceConfig": [
    {
        "type": "menu",
        "label": "Configuration",
        "items": [
            {

                "type": "section",
                "sectionTitle": "Authentication",
                "sectionHelpMessage": "Provide the parameters to connect with the airtable worksheet.",
                "items": [
                    {
                        // The key is what you use to assign initial values to the spec
                        "key": "airtableURL",
                        "label": "airtable url",
                        "required": true,
                        "type": "text"
                    }
                ]
            }
        ]
    }
]

Reserved values​

There are some values that are reserved for use and activate special functions in the connector. Some of them are listed below:

  • provisioningTimeout - Default is 60 seconds. This can be increased if provisioning commands (account enable, account create, etc.) need more time to process
  • supportsStatefulCommands - set to true to allow the connector to accept stateful commands. This will enable an option in the configuration to turn this feature on