Active |
---|
This application does not need additional settings. So you can make connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). only by using your login credentials or by following the instructions below . |
The CloudConvert modulesa module is an application or tool designed to handle specific business functions, such as CRM, project management, or inventory. The system's modular architecture allows you to activate only the modules you need, enabling customization and scalability as your business requirements evolve. allow you to monitor and manage jobs, tasks, and import&export files in your CloudConvert account.
Prerequisites
-
A CloudConvert account
In order to use CloudConvert with Boost.spaceA platform that centralizes and synchronizes company data from internal and external sources, offering a suite of modules and addons for project management, CRM, data visualization, and more. Has many features to optimize your workflow! IntegratorPart of the Boost.space system, where you can create your connections and automate your processes., it is necessary to have a CloudConvert account. If you do not have one, you can create a CloudConvert account at cloudconvert.com/register.
Caution | |
---|---|
The modulea module is an application or tool designed to handle specific business functions, such as CRM, project management, or inventory. The system's modular architecture allows you to activate only the modules you need, enabling customization and scalability as your business requirements evolve. dialog fields that are displayed in bold (in the Boost.space Integrator scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive., not in this documentation article) are mandatory! |
To connect your CloudConvert account to Boost.space Integrator you need to obtain the API Key from your CloudConvert account and insert it in the Create a connection dialog in the Boost.space Integrator module.
1. Log in to your CloudConvert account and open your Dashboard.
2. Open the Authorization > API Keys section.
3. Click on the Create New API key button.
4. Enter the name for the API key, enable the scopes you want to use, and click the Create button.
5. Copy the provided tokenA secure code used to authenticate and authorize access to API endpoints, enabling users to connect with third-party applications. and store it in a safe place.
6. Go to Boost.space Integrator and open the CloudConvert module’s Create a connection dialog.
7. Enter the token you have created in step 5 and click the Continue button to establish the connection.
Converts a specified file to the selected file format.
Connection |
|
Input File |
Select whether you want to upload a file using Boost.space Integrator or provide the URL the file will be uploaded from. |
Upload a File |
Enter the source file by adding the file name and file data manually or by mappingMapping links the modules in your scenario. When you map an item, you connected the data retrieved by one module to another module to perform the desired action. For example, you can map the email address and subject lines from the Email > Watch emails module to Google Sheets > Add a row and create a spreadsheet of email addresses... the file from a previous module. E.g. Dropbox > Get a File. Data Enter or map the file data. File Name Enter the file name including the file extension. E.g. test.txt |
Import a File from URL |
URL Enter the URL of the file you want to convert. Headers Define request headers (optional). Useful, for example, when the specified URL requires the authorization. |
Format |
Select whether you want to specify the input format of the file you want to convert. If not specified, the extension of the input file is used as the input format. |
Input Format |
Select the current format of the file. |
Output Format |
Select the target file format you want to convert the file to. |
File Name |
Choose a filename (including extension) for the target output file. |
Conversion and engine specific options |
Specify conversion and engine specific options. To view available options, please visit their API documentation and select the |
Download a file |
Enable this option to include also file data in the module’s output. |
Captures a specified website and saves it in PDF, JPG, or PNG format.
Connection |
|
URL |
Enter the URL of the website you want to capture. |
Output Format |
Select whether you want to save the captured website in PNG, JPG, or PDF format. |
File Name |
Enter a filename (including extension) for the target output file. |
Headers |
Define request headers (optional). Useful, for example, when the specified URL requires the authorization. |
Conversion and engine specific options |
Specify conversion and engine specific options. To view available options, please visit their API documentation and select the |
Download a file |
Enable this option to include also file data in the module’s output. |
Optimizes and compresses a file. Currently supported formats are PDF, PNG and JPG.
Connection |
|
Input File |
Select whether you want to upload a file using Boost.space Integrator or provide the URL the file will be uploaded from. |
Upload a File |
Enter the source file by adding the file name and file data manually or by mapping the file from a previous module. E.g. Dropbox > Get a File. Data Enter or map the file data. File Name Enter the file name including the file extension. E.g. test.txt |
Import a file from URL |
URL Enter the URL of the file you want to optimize. Headers Define request headers (optional). Useful, for example, when the specified URL requires the authorization. |
Optimization for |
Select the optimization profile for specific target needs.
|
Input format |
Select the format of the input file you want to optimize. |
File name |
Enter the file name (including extension) for the target output file. |
Conversion and engine specific options |
Specify conversion and engine specific options. To view available options, please visit their API documentation and select the |
Download a file |
Enable this option to include also file data in the module’s output. |
Enables you to add one or multiple files to the ZIP, RAR, 7Z, TAR, TAR.GZ or TAR.BZ2 archive.
Connection |
|||||
Input Files |
Specify files you want to add to the archive.
|
||||
Output Format |
Select the target format of the archived file. |
||||
File name |
Enter the file name (including extension) for the target output file. |
||||
Conversion and engine specific options |
Specify conversion and engine specific options. To view available options, please visit their API documentation and select the |
||||
Download a File |
Enable this option to include also file data in the module’s output. |
Merges at least two files into one PDF. If input files are not PDFs yet, they are automatically converted to PDF.
Connection |
|||||
Input Files |
Specify files you want to merge.
|
||||
Output Format |
Select the target format. |
||||
File name |
Enter the file name (including extension) for the target output file. |
||||
Conversion and engine specific options |
Specify conversion and engine specific options. To view available options, please visit their API documentation and select the |
||||
Download a File |
Enable this option to include also file data in the module’s output. |
TriggersThe initial event that starts a scenario. It can be an action, a scheduled time, or a custom event, and is essential to define at the beginning of each scenario. when the job or task is created, has finished, or has failedin your account.
Note | |
---|---|
The job created by the Create a Job (advanced) module consists of several tasks. |
Caution | |
---|---|
The New Job Event triggerThe initial event that starts a scenario. It can be an action, a scheduled time, or a custom event, and is essential to define at the beginning of each scenario. is also triggered when an individual task is created, has finished, or has failed. |
Webhhook name |
Enter the webhookA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers. name. E.g. Document Conversion Finished |
Connection |
|
Event |
Select whether the module is triggered when the job/task is created, has finished, or has failed. |
This module performs a job (a job can be one or multiple tasks that are identified in the Name field and linked between each other using the Input field).
Caution | |
---|---|
For further processing of the finished job created withthe Create a Job module, please use the New Job Event (job.finished) module in another scenario. |
Connection |
|||||
Input Files |
Add the files you want to use within the job.
|
||||
Tasks |
Add tasks that will be performed within the job. Please find the descriptions of the operations’ fields in the corresponding section.
|
||||
Tag |
An arbitrary string to identify the job. Does not have any effect and can be used to associate the job with an ID. |
If working with the Array AggregatorWhen designing a scenario, use an array aggregator to merge multiple bundles into one single bundle. This may be necessary to format data properly for subsequent modules. The array aggregator also lets you define your target data structure. (e.g. you have many files in different formats to convert), use the I don’t know the input format option in the Add a task dialog. Otherwise the errorService is unavailable due to a failure, a service responds with unexpected data or the validation of input data fails. is returned.
Linking tasks within the job (name > input, name > input,…):
Retrieves all jobs that have been run in your account.
Connection |
|
StatusIn Boost.space, statuses are indicators assigned to records within modules to represent their current state or progress. They can be system-defined, such as "Active" or "Done," or custom-created to fit specific workflows. Statuses help track and manage tasks, projects, and processes efficiently. |
Select the job status to filter returned jobs by. |
Limit |
Set the number of returned jobs Boost.space Integrator will return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Retrieves job details.
Connection |
|
Job ID |
Enter (map) the ID of the job you want to retrieve details about. |
Deletes a job, including all tasks and data.
Jobs are deleted automatically 24 hours after they have ended.
Connection |
|
Job ID |
Enter (map) the ID of the job you want to delete. |
Retrieves task details.
Connection |
|
Task ID |
Enter (map) the ID of the task you want to retrieve details about. |
Retrieves file name and file data from the specified task.
Connection |
|
Task ID |
Enter (map) the ID of the task you want to download the file from. |
Retrieves all tasks in your account based on filter settings.
Connection |
|
Status |
Select the task status to filter returned tasks by. |
Job ID |
Enter (map) the Job ID to return only tasks within the specified job. |
OperationOperations are tasks in integration scenarios, similar to "operations" in Make.com. Each action, like reading or updating a record, counts as one operation. They’re essential for data syncing between apps and reset monthly. Going over the limit pauses syncing until you add more or upgrade your plan. |
Enter the operation type to return only tasks with the specified operation. Use the List Possible OperationsOperations are tasks in integration scenarios, similar to "operations" in Make.com. Each action, like reading or updating a record, counts as one operation. They’re essential for data syncing between apps and reset monthly. Going over the limit pauses syncing until you add more or upgrade your plan. module to retrieve operationsOperations are tasks in integration scenarios, similar to "operations" in Make.com. Each action, like reading or updating a record, counts as one operation. They’re essential for data syncing between apps and reset monthly. Going over the limit pauses syncing until you add more or upgrade your plan.. |
Limit |
Set the number of returned tasks Boost.space Integrator will return during one execution cycle. |
Creates a new task, based on the settings (payload) of another task.
Connection |
|
Task ID |
Enter (map) the ID of the task you want to create a new task from. |
Cancels a task that has a status of waiting
or processing
.
Connection |
|
Task ID |
Enter (map) the ID of the task you want to cancel. |
Delete a task, including all data.
Tasks are deleted automatically 24 hours after they have ended.
Connection |
|
Task ID |
Enter (map) the ID of the task you want to delete. |
Retrieves authenticated account details (including credits – remaining conversion minutes).
Allows you to perform a custom API call.
Connection |
|
URL |
Enter a path relative to For the list of available endpoints, refer to the CloudConvert API v2 Documentation. |
Method |
Select the HTTP method you want to use:
|
Headers |
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you. |
Query String |
Enter the request query string. |
Body |
Enter the body content for your API call. |
The following API call returns all tasks from your CloudFront account:
URL:
/v2/tasks
Method:
GET
Matches of the search can be found in the module’s Output under BundleA bundle is a chunk of data and the basic unit for use with modules. A bundle consists of items, similar to how a bag may contain separate, individual items. > Body > data.
In our example, 6 tasks were returned:
The CloudConvert > Convert a Filethrows one of the following errorsService is unavailable due to a failure, a service responds with unexpected data or the validation of input data fails.:
Error
The output file size exceeds the limit allowed for your scenario.
Please refer to file size limits in Working with files.
Error
You have exceeded the maximum conversion time.
The free CloudConvert plan offers 25 conversion minutes daily. If your usage exceeds the limit of the free plan, you may switch to a (prepaid) package or subscription.
Error
Failed to read frame size: Could not seek to 1508. �/output/JLIADSA00137P0.mp3: Invalid argument.
This error is thrown e.g. when converting files from MP3 to WAV. Make sure that you have selected the correct region because it will find references to files but not only just the correct file.
RuntimeError
Maximum number of repeats exceeded.
Locate the corresponding CloudConvert job in your CloudConvert dashboard‘s list of jobs and check the job’s duration:
The CloudConvert > Convert a Filemodule’s timeout is set to 3 minutes. If the job’s duration exceeds 3 minutes (possibly due to a temporary overload of the CloudConvert service), the module throws the above mentioned error.
In this case consider one of these options:
-
Enable the Allow storing of Incomplete Executions option in the scenario settings to store the incomplete executionsSometimes Boost.space Integrator cannot successfully finalize a scenario execution due to an error. Boost.space Integrator stores incomplete executions in a folder named Incomplete Executions. Each stored incomplete execution can be resolved either manually or automatically. for later manual resolution. Optionally you may attach an error handling route to the CloudConvert module with the Break directive to resolve the incomplete executions automatically.
-
Disable the Download a file option in the CloudConvert > Convert a file module. In this case the module will not wait for the conversion result. To obtain the conversion result, create a new scenario and use the CloudConvert > New Job Event trigger.
-
Click on the “Select File” button and choose your sample MOV file.
-
Click on the dropdown, next to “Convert to” and choose MP4.
-
Click on the wrench icon.
-
Configure the MP4 compression settings as you see fit.
-
Click on the Convert button.
-
Once the conversion has been finished, click on the Download button.
-
Review the converted video.
-
Repeat steps 1 to 8 until you have found the optimal conversion settings in step 5.
-
Choose ‘mov’ for the input_format field.
-
Choose ‘mp4’ for the output_format field.
-
A list of all possible parameters like
video_codec
,crf
, etc. will appear. -
In Boost.space Integrator, insert the CloudConvert > Convert a File module in your scenario.
-
Open the module’s settings.
-
Configure the module as shown below:
-
Make sure to include all the settings in the Conversion and engine specific options field: for each setting from step 5, locate the corresponding parameter from step 13 and its corresponding value.