Create Job with Cloud Convert API

Pipedream makes it easy to connect APIs for Cloud Convert and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Job with the Cloud Convert API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Create Job with the Cloud Convert API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Job action
1. Connect your Cloud Convert account
2. Configure Tasks
3. Optional- Configure Tag
4. Optional- Configure Webhook URL
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create Job on Cloud Convert

Description:Creates a new job for one or more tasks. [See the documentation](https://cloudconvert.com/api/v2/jobs#jobs-create)

Version:0.0.1

Key:cloud_convert-create-job

View on GitHub

Code#

import app from "../../cloud_convert.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "cloud_convert-create-job",
  name: "Create Job",
  description: "Creates a new job for one or more tasks. [See the documentation](https://cloudconvert.com/api/v2/jobs#jobs-create)",
  version: "0.0.1",
  type: "action",
  annotations: {
    readOnlyHint: false,
    destructiveHint: false,
    openWorldHint: true,
  },
  props: {
    app,
    tasks: {
      type: "object",
      label: "Tasks",
      description: `An object containing named tasks that form the job workflow. You can name tasks however you want, but **only alphanumeric characters, hyphens (-), and underscores (_) are allowed**.

**Each task object must include:**

- \`operation\` (string, **required**): The endpoint for creating the task (e.g., \`convert\`, \`import/url\`, \`import/s3\`, \`export/s3\`, etc.)
- \`input\` (string or array, optional): The name(s) of the input task(s). Use this to reference other tasks within the same job. Multiple task names can be provided as an array.
- \`ignore_error\` (boolean, optional): By default, the job fails if one task fails. Set to \`true\` to continue the job even if this specific task fails.
- Task-specific options (optional): Additional parameters that depend on the \`operation\` type. These are the same parameters used when creating the task via its direct endpoint.

**Example:**
\`\`\`json
{
  "import-my-file": {
    "operation": "import/url",
    "url": "https://example.com/document.pdf"
  },
  "convert-my-file": {
    "operation": "convert",
    "input": "import-my-file",
    "output_format": "jpg",
    "pages": "1-3"
  },
  "export-my-file": {
    "operation": "export/url",
    "input": ["convert-my-file"]
  }
}
\`\`\`

[See the tasks documentation](https://cloudconvert.com/api/v2/tasks)`,
    },
    tag: {
      type: "string",
      label: "Tag",
      description: "An arbitrary string to identify the job. Does not have any effect and can be used to associate with your application",
      optional: true,
    },
    webhookUrl: {
      type: "string",
      label: "Webhook URL",
      description: "Single-job webhook URL receiving `job.finished` or `job.failed` events",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      app,
      tasks,
      tag,
      webhookUrl,
    } = this;

    const response = await app.createJob({
      $,
      data: {
        tasks: utils.parseJson(tasks),
        tag,
        webhook_url: webhookUrl,
      },
    });

    $.export("$summary", `Successfully created job with ID \`${response.data.id}\``);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Cloud Convert	`app`	`app`	This component uses the Cloud Convert app.
Tasks	`tasks`	`object`	An object containing named tasks that form the job workflow. You can name tasks however you want, but only alphanumeric characters, hyphens (-), and underscores (_) are allowed. Each task object must include: `operation` (string, required): The endpoint for creating the task (e.g., `convert`, `import/url`, `import/s3`, `export/s3`, etc.) `input` (string or array, optional): The name(s) of the input task(s). Use this to reference other tasks within the same job. Multiple task names can be provided as an array. `ignore_error` (boolean, optional): By default, the job fails if one task fails. Set to `true` to continue the job even if this specific task fails. Task-specific options (optional): Additional parameters that depend on the `operation` type. These are the same parameters used when creating the task via its direct endpoint. Example: `{ "import-my-file": { "operation": "import/url", "url": "https://example.com/document.pdf" }, "convert-my-file": { "operation": "convert", "input": "import-my-file", "output_format": "jpg", "pages": "1-3" }, "export-my-file": { "operation": "export/url", "input": ["convert-my-file"] } }` See the tasks documentation
Tag	`tag`	`string`	An arbitrary string to identify the job. Does not have any effect and can be used to associate with your application
Webhook URL	`webhookUrl`	`string`	Single-job webhook URL receiving `job.finished` or `job.failed` events

Authentication#

Cloud Convert uses OAuth authentication. When you connect your Cloud Convert account, Pipedream will open a popup window where you can sign into Cloud Convert and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Cloud Convert API.

Pipedream requests the following authorization scopes when you connect your account:

user.readuser.writetask.readtask.writewebhook.readwebhook.write