Admin

Create an integration

POST
Create an integration

Request

This endpoint expects an object.
integration_vendor
enumRequired
The integration vendor
credentials
unionRequired
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

Response

This endpoint returns an object
result
object
POST
1curl -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": "BUILDIUM",
6 "credentials": {
7 "clientId": "clientId",
8 "secret": "secret"
9 },
10 "name": "name",
11 "sync_frequency": 1,
12 "sync_cadence": "MINUTE"
13}'
200Successful
1{
2 "result": {
3 "id": "clwktsp9v000008l31iv218hn",
4 "created_at": "2024-03-21T15:38:08.337Z",
5 "updated_at": "2024-03-22T10:59:45.119Z",
6 "vendor": "BUILDIUM",
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 "ping_results": "ping_results"
15 },
16 "new_properties_are_enabled": true,
17 "allow_manual_syncs": true,
18 "name": "name",
19 "max_request_cadence": "MINUTE",
20 "max_request_frequency": 10,
21 "max_job_concurrency": 1,
22 "base_url": "base_url"
23 }
24}