Create Design from Brand Template with Canva Enterprise API on Monthly Schedule from Schedule API

Pipedream makes it easy to connect APIs for Canva Enterprise, Schedule and 2,400+ other apps remarkably fast.

Trigger workflow on

Monthly Schedule from the Schedule API

Next, do this

Create Design from Brand Template with the Canva Enterprise 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#

This integration creates a workflow with a Schedule trigger and Canva Enterprise action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Monthly Schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Design from Brand Template action
1. Connect your Canva Enterprise account
2. Select a Brand Template ID
3. Configure alert
4. Optional- Configure Title
5. Optional- Configure Wait for Completion
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

Monthly Schedule on Schedule

Description:Trigger your workflow on one or more days each month at a specific time (with timezone support).

Version:0.0.2

Key:schedule-monthly

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Monthly Schedule",
  version: "0.0.2",
  key: "schedule-monthly",
  type: "source",
  description: "Trigger your workflow on one or more days each month at a specific time (with timezone support).",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 10 1 * *",
      },
    },
  },
};

Trigger 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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Create Design from Brand Template on Canva Enterprise

Description:Creates an asynchronous job to autofill a design from a brand template with your input information. [See the documentation](https://www.canva.dev/docs/connect/api-reference/autofills/create-design-autofill-job/)

Version:0.0.1

Key:canva_enterprise-create-design-from-brand-template

View on GitHub

Action Code#

import canva from "../../canva_enterprise.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "canva_enterprise-create-design-from-brand-template",
  name: "Create Design from Brand Template",
  description: "Creates an asynchronous job to autofill a design from a brand template with your input information. [See the documentation](https://www.canva.dev/docs/connect/api-reference/autofills/create-design-autofill-job/)",
  version: "0.0.1",
  type: "action",
  props: {
    canva,
    brandTemplateId: {
      propDefinition: [
        canva,
        "brandTemplateId",
      ],
      reloadProps: true,
    },
    alert: {
      type: "alert",
      alertType: "error",
      content: "Design not fillable. Design does not have any autofill capable elements.",
      hidden: true,
    },
    title: {
      type: "string",
      label: "Title",
      description: "Title to use for the autofilled design. Must be less than 256 characters. If no design title is provided, the autofilled design will have the same title as the brand template.",
      optional: true,
    },
    waitForCompletion: {
      propDefinition: [
        canva,
        "waitForCompletion",
      ],
    },
  },
  async additionalProps(existingProps) {
    const props = {};
    if (!this.brandTemplateId) {
      return props;
    }
    const { dataset } = await this.canva.getBrandTemplateDataset({
      brandTemplateId: this.brandTemplateId,
    });
    if (!dataset) {
      existingProps.alert.hidden = false;
      return props;
    }
    for (const [
      key,
      value,
    ] of Object.entries(dataset)) {
      props[key] = {
        type: "string",
        label: `${key}`,
        description: value.type === "image"
          ? "The asset ID of an image"
          : "Please enter a text string",
      };
    }
    return props;
  },
  async run({ $ }) {
    const { dataset } = await this.canva.getBrandTemplateDataset({
      $,
      brandTemplateId: this.brandTemplateId,
    });
    if (!dataset) {
      throw new ConfigurationError("Design not fillable. Design does not have any autofill capable elements.");
    }
    for (const [
      key,
      value,
    ] of Object.entries(dataset)) {
      if (value.type === "image") {
        dataset[key].asset_id = this[key];
      } else {
        dataset[key].text = this[key];
      }
    }
    let response = await this.canva.createDesignAutofillJob({
      $,
      data: {
        brand_template_id: this.brandTemplateId,
        data: dataset || {},
        title: this.title,
      },
    });

    if (this.waitForCompletion) {
      const timer = (ms) => new Promise((res) => setTimeout(res, ms));
      const jobId = response.job.id;
      while (response.job.status === "in_progress") {
        response = await this.canva.getDesignAutofillJob({
          $,
          jobId,
        });
        if (response.job.error) {
          throw new Error(response.job.error.message);
        }
        await timer(3000);
      }
    }

    $.export("$summary", `Successfully ${this.waitForCompletion
      ? "created"
      : "started autofil job for"} design`);

    return response;
  },
};

Action Configuration#

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

Label	Prop	Type	Description
Canva Enterprise	`canva`	`app`	This component uses the Canva Enterprise app.
Brand Template ID	`brandTemplateId`	`string`	Select a value from the drop down menu.
Title	`title`	`string`	Title to use for the autofilled design. Must be less than 256 characters. If no design title is provided, the autofilled design will have the same title as the brand template.
Wait for Completion	`waitForCompletion`	`boolean`	Set to `true` to poll the API in 3-second intervals until the job is completed

Action Authentication#

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

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

profile:readasset:readasset:writebrandtemplate:content:readbrandtemplate:meta:readdesign:content:readdesign:content:writedesign:meta:read