Repzo API - Integration App (1.0.0)

Download OpenAPI specification:Download

OpenAPI specification for Repzo Integration App endpoints.

Find integration apps

query Parameters

object

Query parameters for filtering integration apps

Responses

Response samples

200

Content type

application/json

{"data": [{"_id": "string",
"name": "string",
"description": "string",
"category": "string",
"version": "string",
"status": "active",
"available_app": "string",
"company_namespace": "string",
"config": { },
"credentials": { },
"endpoints": { },
"webhooks": { },
"sync_settings": { },
"last_sync": "2019-08-24T14:15:22Z",
"error_count": 0,
"success_count": 0,
"integration_meta": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}
],
"total_result": 0,
"current_count": 0,
"total_pages": 0,
"current_page": 0,
"per_page": 0
}

Create an integration app

Request Body schema: application/json

name required	string Name of the integration app
description	string Description of the integration app
available_app required	string Available app reference
company_namespace required	string Company namespace
	object Configuration settings for the integration
	object Credentials for the integration
	object API endpoints configuration
	object Webhook configuration
	object Synchronization settings
	object Integration metadata

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"available_app": "string",
"company_namespace": "string",
"config": { },
"credentials": { },
"endpoints": { },
"webhooks": { },
"sync_settings": { },
"integration_meta": { }
}

Response samples

201

Content type

application/json

{"_id": "string",
"name": "string",
"description": "string",
"category": "string",
"version": "string",
"status": "active",
"available_app": "string",
"company_namespace": "string",
"config": { },
"credentials": { },
"endpoints": { },
"webhooks": { },
"sync_settings": { },
"last_sync": "2019-08-24T14:15:22Z",
"error_count": 0,
"success_count": 0,
"integration_meta": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Get an integration app by ID

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"_id": "string",
"name": "string",
"description": "string",
"category": "string",
"version": "string",
"status": "active",
"available_app": "string",
"company_namespace": "string",
"config": { },
"credentials": { },
"endpoints": { },
"webhooks": { },
"sync_settings": { },
"last_sync": "2019-08-24T14:15:22Z",
"error_count": 0,
"success_count": 0,
"integration_meta": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}

Update an integration app

path Parameters

id

required

string

Request Body schema: application/json

name	string Name of the integration app
description	string Description of the integration app
status	string Enum: "active" "inactive" "pending" Status of the integration app
	object Configuration settings for the integration
	object Credentials for the integration
	object API endpoints configuration
	object Webhook configuration
	object Synchronization settings
	object Integration metadata

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"status": "active",
"config": { },
"credentials": { },
"endpoints": { },
"webhooks": { },
"sync_settings": { },
"integration_meta": { }
}

Response samples

200

Content type

application/json

{"_id": "string",
"name": "string",
"description": "string",
"category": "string",
"version": "string",
"status": "active",
"available_app": "string",
"company_namespace": "string",
"config": { },
"credentials": { },
"endpoints": { },
"webhooks": { },
"sync_settings": { },
"last_sync": "2019-08-24T14:15:22Z",
"error_count": 0,
"success_count": 0,
"integration_meta": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0
}