Create Editor Session with CraftMyPDF API on New Product Event (Instant) from WooCommerce API

Pipedream makes it easy to connect APIs for CraftMyPDF, WooCommerce and 2,400+ other apps remarkably fast.

Trigger workflow on

New Product Event (Instant) from the WooCommerce API

Next, do this

Create Editor Session with the CraftMyPDF 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 WooCommerce trigger and CraftMyPDF action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Product Event (Instant) trigger
1. Connect your WooCommerce account
2. Select one or more Event topics
Configure the Create Editor Session action
1. Connect your CraftMyPDF account
2. Select a Template Id
3. Configure Expiration (in minutes)
4. Optional- Configure Can Save
5. Optional- Configure Can Create PDF
6. Optional- Configure Can View Settings
7. Optional- Configure Can Preview
8. Optional- Configure Can Edit JSON
9. Optional- Configure Can Show Header
10. Optional- Configure Can Show Layers
11. Optional- Configure Can Show Property Panel
12. Optional- Configure Can Show Help
13. Optional- Configure Can Show Data
14. Optional- Configure Can Show Expression Doc
15. Optional- Configure Can Show Property Binding
16. Optional- Configure Can Show Back URL
17. Optional- Configure JSON Mode
18. Optional- Configure Back URL
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#

New Product Event (Instant) on WooCommerce

Description:Emit new event each time the specified product event(s) occur

Version:0.0.3

Key:woocommerce-new-product-event

View on GitHub

WooCommerce Overview#

WooCommerce is a customizable, open-source eCommerce platform built on WordPress. With the WooCommerce API, you can tap into the heart of your eCommerce store to read, create, update, and delete products, orders, and customers. On Pipedream, you can harness this API to automate routine tasks, sync data across platforms, and enhance customer experiences. By connecting WooCommerce to a wide array of apps and services, you can streamline operations, trigger personalized marketing, and analyze your sales data with greater ease.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "woocommerce-new-product-event",
  name: "New Product Event (Instant)",
  description: "Emit new event each time the specified product event(s) occur",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async getSampleEvents({ perPage }) {
      return this.woocommerce.listProducts({
        per_page: perPage,
        orderby: "date",
      });
    },
    getTopic(topicType) {
      return `product.${topicType}`;
    },
    generateMeta(eventType, {
      id, name, date_modified: dateModified,
    }) {
      const ts = Date.parse(dateModified);
      return {
        id: `${id}${ts}`,
        summary: `Product "${name || id}" ${eventType}`,
        ts,
      };
    },
  },
};

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
WooCommerce	`woocommerce`	`app`	This component uses the WooCommerce app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Event topics	`topics`	`string[]`	Select a value from the drop down menu:`createdupdateddeleted`

Trigger Authentication#

WooCommerce uses API keys for authentication. When you connect your WooCommerce account, Pipedream securely stores the keys so you can easily authenticate to WooCommerce APIs in both code and no-code steps.

Find your API key at WooCommerce > Settings > Advanced > REST API. See the WooCommerce docs for more info. Enter the Key and Secret below.

About WooCommerce#

WooCommerce is the open-source ecommerce platform for WordPress.

Action#

Create Editor Session on CraftMyPDF

Description:Create a new PDF editor session. The PDF editor url can be embedded into an IFrame. [See the documentation](https://craftmypdf.com/docs/index.html#tag/Template-Management-API/operation/delete-template)

Version:0.0.1

Key:craftmypdf-create-editor-session

View on GitHub

CraftMyPDF Overview#

CraftMyPDF is a powerful API that allows you to create dynamic and customizable PDF documents. By leveraging this API on Pipedream, you can automate the generation of invoices, reports, tickets, and any other document that requires a polished and professional look. Pipedream's serverless platform enables you to connect CraftMyPDF with numerous apps to create workflows that trigger PDF generation from events like form submissions, new database entries, or scheduled jobs.

Action Code#

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

export default {
  key: "craftmypdf-create-editor-session",
  name: "Create Editor Session",
  version: "0.0.1",
  description: "Create a new PDF editor session. The PDF editor url can be embedded into an IFrame. [See the documentation](https://craftmypdf.com/docs/index.html#tag/Template-Management-API/operation/delete-template)",
  type: "action",
  props: {
    craftmypdf,
    templateId: {
      propDefinition: [
        craftmypdf,
        "templateId",
      ],
    },
    expiration: {
      propDefinition: [
        craftmypdf,
        "expiration",
      ],
    },
    canSave: {
      type: "boolean",
      label: "Can Save",
      description: "Can save the template. Default to `true`.",
      optional: true,
    },
    canCreatePDF: {
      type: "boolean",
      label: "Can Create PDF",
      description: "Can Generate PDF. Default to `true`.",
      optional: true,
    },
    canViewSettings: {
      type: "boolean",
      label: "Can View Settings",
      description: "Can view settings. Default to `true`.",
      optional: true,
    },
    canPreview: {
      type: "boolean",
      label: "Can Preview",
      description: "Can preview. Default to `true`.",
      optional: true,
    },
    canEditJSON: {
      type: "boolean",
      label: "Can Edit JSON",
      description: "Can edit JSON. Default to `true`.",
      optional: true,
    },
    canShowHeader: {
      type: "boolean",
      label: "Can Show Header",
      description: "Show CraftMyPDF header. Default to `true`.",
      optional: true,
    },
    canShowLayers: {
      type: "boolean",
      label: "Can Show Layers",
      description: "Show layer dialogue. Default to `true`.",
      optional: true,
    },
    canShowPropertyPanel: {
      type: "boolean",
      label: "Can Show Property Panel",
      description: "Show property panel. Default to `true`.",
      optional: true,
    },
    canShowHelp: {
      type: "boolean",
      label: "Can Show Help",
      description: "Show `Help` tab. Default to `true`.",
      optional: true,
    },
    canShowData: {
      type: "boolean",
      label: "Can Show Data",
      description: "Show `Data` tab. Default to `true`.",
      optional: true,
    },
    canShowExpressionDoc: {
      type: "boolean",
      label: "Can Show Expression Doc",
      description: "Show `Expression Doc` tab. Default to `true`.",
      optional: true,
    },
    canShowPropertyBinding: {
      type: "boolean",
      label: "Can Show Property Binding",
      description: "Show `Property Bind` tab for element. Default to `true`.",
      optional: true,
    },
    canShowBackURL: {
      type: "boolean",
      label: "Can Show Back URL",
      description: "Show `BackURL` button. Default to `true`.",
      optional: true,
    },
    jsonMode: {
      type: "integer",
      label: "JSON Mode",
      description: "JSON editor - `1`, JSON viewer - `2`.",
      optional: true,
    },
    backURL: {
      type: "string",
      label: "Back URL",
      description: "The URL for the back button",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      craftmypdf,
      templateId,
      ...data
    } = this;

    const response = await craftmypdf.createEditorSession({
      $,
      data: {
        ...data,
        template_id: templateId,
      },
    });

    $.export("$summary", "A new editor session was successfully created!");
    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
CraftMyPDF	`craftmypdf`	`app`	This component uses the CraftMyPDF app.
Template Id	`templateId`	`string`	Select a value from the drop down menu.
Expiration (in minutes)	`expiration`	`integer`	Expiration of the generated PDF in minutes. Default to 5 minutes. Range between 1 minute and 24 hours.
Can Save	`canSave`	`boolean`	Can save the template. Default to `true`.
Can Create PDF	`canCreatePDF`	`boolean`	Can Generate PDF. Default to `true`.
Can View Settings	`canViewSettings`	`boolean`	Can view settings. Default to `true`.
Can Preview	`canPreview`	`boolean`	Can preview. Default to `true`.
Can Edit JSON	`canEditJSON`	`boolean`	Can edit JSON. Default to `true`.
Can Show Header	`canShowHeader`	`boolean`	Show CraftMyPDF header. Default to `true`.
Can Show Layers	`canShowLayers`	`boolean`	Show layer dialogue. Default to `true`.
Can Show Property Panel	`canShowPropertyPanel`	`boolean`	Show property panel. Default to `true`.
Can Show Help	`canShowHelp`	`boolean`	Show `Help` tab. Default to `true`.
Can Show Data	`canShowData`	`boolean`	Show `Data` tab. Default to `true`.
Can Show Expression Doc	`canShowExpressionDoc`	`boolean`	Show `Expression Doc` tab. Default to `true`.
Can Show Property Binding	`canShowPropertyBinding`	`boolean`	Show `Property Bind` tab for element. Default to `true`.
Can Show Back URL	`canShowBackURL`	`boolean`	Show `BackURL` button. Default to `true`.
JSON Mode	`jsonMode`	`integer`	JSON editor - `1`, JSON viewer - `2`.
Back URL	`backURL`	`string`	The URL for the back button

Action Authentication#

CraftMyPDF uses API keys for authentication. When you connect your CraftMyPDF account, Pipedream securely stores the keys so you can easily authenticate to CraftMyPDF APIs in both code and no-code steps.

To retrieve your API keys,