Skip to main content

Properties

Connectors Properties and Integrations Properties serve as configuration parameters. Connector properties act as a template, describing what can be configued for an Integration of that Connector. These properties enable users to customize Integrations to meet specific requirements.

Configuring Properties in Connectors and Integrations​

Connector Configuration​

In the Connector, properties are defined under the properties tab.

Say that we want to add a webhookSecret as an Connector property, here's how you could define that for a Connector:

  1. Navigate to the properties tab on the Connector's page.
  2. Add a new property, for example, webhookSecret, specifying its data type as String.

Adding values doesn't make sense here, as the Connector shouldn't know the list of secrets which are available. Values can be useful if there are a known set of possible values for a given property.

Integration Configuration​

For the Integration, properties values are then set through the properties tab on the Integration Properties page:

  1. Navigate to the properties tab on the Integration page.
  2. Add the webhookSecret property and specify its value as needed.

Using Integration Properties in a Connector​

The Integration Properties will then be available when requesting the Integration configuration from SyncHive.

GEThttps://{synchive_url}/v1/integration

Example response:

{
    "integration": {
      // ...
    },
    "contact": {
      // ...
    },
    "shapes": [
      // ...
    ],
    "propertyValues": [
        {
            "name": "webhookSecret",
            "value": "3tuCsUi3zopbxWmuqFDe"
        }
    ]