File-based Integrations

This resource allows you to run file-based integration processes.

The payload is a flat file delivered by SFTP. You can run the integration from the Integration Hub user interface or with API calls. The REST API calls do not carry the data. The amount of data is not limited, and the response time depends on the size of the file. These integrations can transform or map the incoming or outgoing data, and can be run on-demand or be scheduled. Use this type of integration for bulk updates or when you need to transform the data.

Operations


Create an Integration Process
POST /v1/platform/integrations


Delete Integration by ID
DELETE /v1/platform/integrations/{id}


Execute Integration by ID
POST /v1/platform/integrations/{id}/execute


Retrieve Integration Process by ID
GET /v1/platform/integrations/{id}


Retrieve Integrations
GET /v1/platform/integrations


Schedule Integration by ID
POST /v1/platform/integrations/{id}/schedule


Update Integration by ID
PUT /v1/platform/integrations/{id}