JSON encoded credentials for accessing the integration vendor API
name
stringRequired
The name of the integration
sync_frequency
integerRequired
The interval of the scheduled sync frequency. (e.g. "12" in the following: Sync every 12 HOURs)
sync_cadence
enumRequired
The cadence of the scheduled sync frequency. (e.g. "HOUR" in the following: Sync every 12 HOURs)
system
enumOptional
Deprecated: Do not use
Allowed values: PRODUCTIONSANDBOX
max_request_cadence
enumOptional
The cadence at which to limit the max request frequency. (e.g. "SECOND" in the following: 1 request per 2 SECONDs)
max_request_frequency
doubleOptionalDefaults to 1
The maximum number of requests sent to the PMS API per cadence unit. (e.g. "2" in the following: 1 request per 2 SECONDs)
max_job_concurrency
integerOptionalDefaults to 1
Maximum number of jobs that can be run at once for the integration. (e.g. "1" in the following: 1 request per 2 SECONDs) — Please contact support to increase this limit.
active
booleanOptional
The active state of the integration
base_url
stringOptional
DEPRECATED. See specific PMS credentials for usage.
new_properties_are_enabled
booleanOptional
Whether or not properties need to be approved before by you ingesting data for them.
based_on_integration_id
stringOptional
A reference integration_id to base the creation of an integration on. This includes copying job scheduling frequency and similar configuration. Credentials are not copied and must still be provided.
allow_manual_syncs
booleanOptional
Opt-in to allow manual syncs for this integration to be triggered via the API