Create an integration

Request

This endpoint expects an object.

integration_vendorenumRequired

The integration vendor

credentialsobjectRequired

JSON encoded credentials for accessing the integration vendor API

namestringRequired

The name of the integration

sync_frequencyintegerOptional>=1Defaults to 12

The interval of the scheduled sync frequency. (e.g. “12” in the following: Sync every 12 HOURs). This value will be used if the use_custom_schedule is set to false.

sync_cadenceenumOptionalDefaults to HOUR

The cadence of the scheduled sync frequency. (e.g. “HOUR” in the following: Sync every 12 HOURs). This value will be used if the use_custom_schedule is set to false.

max_request_cadenceenumOptionalDefaults to SECOND

The cadence at which to limit the max request frequency. (e.g. “SECOND” in the following: 1 request per 2 SECONDs). Requests cannot be made less frequently than once per minute

max_request_frequencydoubleOptional>=1Defaults 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). Requests cannot be made less frequently than once per minute

max_job_concurrencyintegerOptional>=1<=100Defaults 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)

activebooleanOptionalDefaults to false

The active state of the integration

new_properties_are_enabledbooleanOptionalDefaults to false

Whether or not properties need to be approved before by you ingesting data for them.

based_on_integration_idstringOptional

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.

custom_sync_scheduleobjectOptional

A custom sync schedule configuration object which will be respected if use_custom_schedule is set to true

use_custom_sync_schedulebooleanOptionalDefaults to false

Opt-in to use the configured custom_sync_schedule

system"PRODUCTION" or "SANDBOX"OptionalDeprecated

Allowed values: PRODUCTIONSANDBOX

Deprecated: Do not use

base_urlstringOptionalDeprecated

DEPRECATED. See specific PMS credentials for usage.

allow_manual_syncsbooleanOptionalDefaults to falseDeprecated

Deprecated: This is no longer configurable and will always be true

Response

Successful response

resultobject

1	curl -X POST https://api.propexo.com/v1/admin/integrations/ \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"integration_vendor": "SAMPLE2",
6	"credentials": {
7	"username": "username",
8	"password": "password",
9	"database": "database",
10	"serverName": "serverName",
11	"platform": "platform",
12	"entity": "entity",
13	"license": "license",
14	"companyId": "companyId"
15	},
16	"name": "name"
17	}'

1	{
2	"result": {
3	"id": "id",
4	"created_at": "created_at",
5	"updated_at": "updated_at",
6	"vendor": "SAMPLE2",
7	"active": true,
8	"system": "PRODUCTION",
9	"sync_frequency": 1,
10	"sync_cadence": "MINUTE",
11	"customer_id": "customer_id",
12	"is_archived": true,
13	"ping_results": {
14	"key": "value"
15	},
16	"new_properties_are_enabled": true,
17	"use_custom_sync_schedule": true,
18	"name": "name",
19	"max_request_cadence": "MINUTE",
20	"max_request_frequency": 10,
21	"max_job_concurrency": 1,
22	"custom_sync_schedule": {
23	"type": "WEEK_BASED",
24	"timezone": "UTC",
25	"interval": {}
26	},
27	"base_url": "base_url",
28	"allow_manual_syncs": true
29	}
30	}

Request

Response

Errors