This resource allows you to run integrations directly from the API to the data elements without the user interface.
API-based integrations do not use SFTP or flat files to pass the data, cannot be scheduled, and pass the data in the payload of the REST API calls. The size of the data payload is limited, and the data is not transformed in any way. This type of integration is synchronous, responses are detected quickly, and the status is updated immediately even if the integration fails or is blocked. Use this type of integration when you must preserve the data without transformations, for example: import people, update punches, or update accrual balances.
Operations
Execute API Integration by Key
POST /v1/platform/api_integrations/execute/{key}
Retrieve API Integration by Key
GET /v1/platform/api_integrations/{key}
Retrieve API Integrations
GET /v1/platform/api_integrations
Retrieve Integration Status by ID
GET /v1/platform/api_integrations/{id}/status