Admin

Create an integration

POST
https://api.propexo.com/v1/admin/integrations
Create an integration

Request

This endpoint expects an object.
integration_vendor
enum
The integration vendor
credentials
union
JSON encoded credentials for accessing the integration vendor API
name
string
The name of the integration
system
optional enum
Deprecated: The system the integration is associated with
Allowed values: PRODUCTIONSANDBOX
max_request_cadence
optional enum
Cadence at which to limit the max request frequency
max_request_frequency
optional double
Number of request cadence units
max_job_concurrency
optional integer
Maximum number of jobs that can be run at once for the integration. Please contact support to increase this limit.
active
optional boolean
The active state of the integration
base_url
optional string
DEPRECATED: see specific PMS credentials. Base URL for the integration vendor API
new_properties_are_enabled
optional boolean
Whether or not properties need to be approved before ingesting data for them.
based_on_integration_id
optional string
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.

Response

This endpoint return an object.
result
object
POST
/v1/admin/integrations
curl -X POST https://api.propexo.com/v1/admin/integrations \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"integration_vendor": "BUILDIUM",
"credentials": {
"username": "username",
"password": "password",
"database": "database",
"serverName": "serverName",
"platform": "platform",
"entity": "entity",
"license": "license",
"companyId": "companyId"
},
"name": "name"
}'
Response
{
"result": {
"id": "id",
"created_at": "created_at",
"updated_at": "updated_at",
"vendor": "BUILDIUM",
"active": true,
"system": "PRODUCTION",
"max_job_concurrency": 1,
"max_request_frequency": 1,
"max_request_cadence": "MINUTE",
"customer_id": "customer_id",
"is_archived": true,
"ping_results": {
"ping_results": "ping_results"
},
"new_properties_are_enabled": true,
"name": "name",
"base_url": "base_url"
}
}