Download OpenAPI specification:Download
API for managing integration action logs
Retrieve a list of all integration action log records with optional filtering and pagination
| limit | integer [ 1 .. 100 ] Default: 50 Maximum number of records to return |
| offset | integer >= 0 Default: 0 Number of records to skip for pagination |
| sort | string Field to sort by |
| order | string Default: "desc" Enum: "asc" "desc" Sort order (asc or desc) |
| filter | string Filter conditions in JSON format |
| search | string Search term for text fields |
{- "success": true,
- "data": [
- {
- "_id": "60f7b1b3e4b0e8b3f8b3f8b3",
- "integrationId": "60f7b1b3e4b0e8b3f8b3f8b4",
- "actionType": "create",
- "entityType": "product",
- "entityId": "60f7b1b3e4b0e8b3f8b3f8b5",
- "status": "success",
- "payload": { },
- "response": { },
- "errorMessage": "string",
- "retryCount": 0,
- "executionTime": 0,
- "metadata": { },
- "createdAt": "2023-01-15T08:00:00Z",
- "updatedAt": "2023-01-15T10:30:00Z"
}
], - "total": 0
}Create a new integration action log record with the provided data
| integrationId required | string Integration identifier |
| actionType required | string Enum: "create" "update" "delete" "sync" "webhook" Type of action performed |
| entityType required | string Type of entity affected |
| entityId | string ID of the affected entity |
| status required | string Enum: "pending" "success" "failed" "retrying" Status of the action |
object Action payload data | |
object Response data from the action | |
| errorMessage | string Error message if action failed |
| retryCount | integer >= 0 Default: 0 Number of retry attempts |
| executionTime | number Execution time in milliseconds |
object Additional metadata |
{- "integrationId": "60f7b1b3e4b0e8b3f8b3f8b4",
- "actionType": "create",
- "entityType": "product",
- "entityId": "60f7b1b3e4b0e8b3f8b3f8b5",
- "status": "success",
- "payload": { },
- "response": { },
- "errorMessage": "string",
- "retryCount": 0,
- "executionTime": 0,
- "metadata": { }
}{- "success": true,
- "data": {
- "_id": "60f7b1b3e4b0e8b3f8b3f8b3",
- "integrationId": "60f7b1b3e4b0e8b3f8b3f8b4",
- "actionType": "create",
- "entityType": "product",
- "entityId": "60f7b1b3e4b0e8b3f8b3f8b5",
- "status": "success",
- "payload": { },
- "response": { },
- "errorMessage": "string",
- "retryCount": 0,
- "executionTime": 0,
- "metadata": { },
- "createdAt": "2023-01-15T08:00:00Z",
- "updatedAt": "2023-01-15T10:30:00Z"
}
}Retrieve a specific integration action log record by its ID
| id required | string Integration action log record ID |
{- "success": true,
- "data": {
- "_id": "60f7b1b3e4b0e8b3f8b3f8b3",
- "integrationId": "60f7b1b3e4b0e8b3f8b3f8b4",
- "actionType": "create",
- "entityType": "product",
- "entityId": "60f7b1b3e4b0e8b3f8b3f8b5",
- "status": "success",
- "payload": { },
- "response": { },
- "errorMessage": "string",
- "retryCount": 0,
- "executionTime": 0,
- "metadata": { },
- "createdAt": "2023-01-15T08:00:00Z",
- "updatedAt": "2023-01-15T10:30:00Z"
}
}Update an existing integration action log record with new data
| id required | string Integration action log record ID |
| integrationId required | string Integration identifier |
| actionType required | string Enum: "create" "update" "delete" "sync" "webhook" Type of action performed |
| entityType required | string Type of entity affected |
| entityId | string ID of the affected entity |
| status required | string Enum: "pending" "success" "failed" "retrying" Status of the action |
object Action payload data | |
object Response data from the action | |
| errorMessage | string Error message if action failed |
| retryCount | integer >= 0 Default: 0 Number of retry attempts |
| executionTime | number Execution time in milliseconds |
object Additional metadata |
{- "integrationId": "60f7b1b3e4b0e8b3f8b3f8b4",
- "actionType": "create",
- "entityType": "product",
- "entityId": "60f7b1b3e4b0e8b3f8b3f8b5",
- "status": "success",
- "payload": { },
- "response": { },
- "errorMessage": "string",
- "retryCount": 0,
- "executionTime": 0,
- "metadata": { }
}{- "success": true,
- "data": {
- "_id": "60f7b1b3e4b0e8b3f8b3f8b3",
- "integrationId": "60f7b1b3e4b0e8b3f8b3f8b4",
- "actionType": "create",
- "entityType": "product",
- "entityId": "60f7b1b3e4b0e8b3f8b3f8b5",
- "status": "success",
- "payload": { },
- "response": { },
- "errorMessage": "string",
- "retryCount": 0,
- "executionTime": 0,
- "metadata": { },
- "createdAt": "2023-01-15T08:00:00Z",
- "updatedAt": "2023-01-15T10:30:00Z"
}
}Delete an existing integration action log record
| id required | string Integration action log record ID |
{- "success": true,
- "message": "Integration action log record deleted successfully"
}