Run Task Synchronously with Apify API on New Watched Event (Instant) from Printify API

Pipedream makes it easy to connect APIs for Apify, Printify and 2,900+ other apps remarkably fast.

Trigger workflow on

New Watched Event (Instant) from the Printify API

Next, do this

Run Task Synchronously with the Apify 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 Printify trigger and Apify action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Watched Event (Instant) trigger
1. Connect your Printify account
2. Select a Shop ID
3. Select a Webhook Topic
Configure the Run Task Synchronously action
1. Connect your Apify account
2. Select a Task ID
3. Optional- Configure Timeout
4. Optional- Configure Memory
5. Optional- Configure Build
6. Optional- Configure Clean
7. Optional- Configure Fields
8. Optional- Configure Omit
9. Optional- Configure Flatten
10. Optional- Configure Limit
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 Watched Event (Instant) on Printify

Description:Emit new event when a specific event occurs in your Printify shop.

Version:0.0.1

Key:printify-watch-events-instant

View on GitHub

Printify Overview#

The Printify API, accessible within Pipedream's platform, offers a suite of operations to streamline your print-on-demand business. It allows you to create products, manage orders, sync inventory, and handle a variety of other e-commerce functions programmatically. With Pipedream's serverless execution environment, you can tap into the Printify API to automate workflows, integrate with other apps, and manipulate data without the need to manage infrastructure.

Trigger Code#

import { randomUUID } from "crypto";
import { secureCompare } from "../../common/utils.mjs";
import printify from "../../printify.app.mjs";

export default {
  key: "printify-watch-events-instant",
  name: "New Watched Event (Instant)",
  description: "Emit new event when a specific event occurs in your Printify shop.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    printify,
    db: "$.service.db",
    http: "$.interface.http",
    shopId: {
      propDefinition: [
        printify,
        "shopId",
      ],
    },
    topic: {
      type: "string",
      label: "Webhook Topic",
      description: "The event that triggers the webhook.",
      async options() {
        return [
          {
            label: "Shop Disconnected",
            value: "shop:disconnected",
          },
          {
            label: "Product Deleted",
            value: "product:deleted",
          },
          {
            label: "Product Publish Started",
            value: "product:publish:started",
          },
          {
            label: "Order Created",
            value: "order:created",
          },
          {
            label: "Order Updated",
            value: "order:updated",
          },
          {
            label: "Order Sent to Production",
            value: "order:sent-to-production",
          },
          {
            label: "Order Shipment Created",
            value: "order:shipment:created",
          },
          {
            label: "Order Shipment Delivered",
            value: "order:shipment:delivered",
          },
        ];
      },
    },
  },
  hooks: {
    async activate() {
      const uuid = randomUUID();
      const webhook = await this.printify.createHook({
        shopId: this.shopId,
        data: {
          topic: this.topic,
          url: this.http.endpoint,
          secret: uuid,
        },
      });
      this.db.set("webhookId", webhook.id);
      this.db.set("uuid", uuid);
    },
    async deactivate() {
      const webhookId = this.db.get("webhookId");
      await this.printify.deleteHook({
        shopId: this.shopId,
        webhookId,
      });
    },
  },
  async run(event) {
    const uuid = this.db.get("uuid");
    if (!secureCompare(event.headers["x-pfy-signature"], event, uuid)) {
      return false;
    }

    this.$emit(event.body, {
      id: event.body.id,
      summary: `New event for topic ${event.body.type}`,
      ts: Date.parse(event.body.created_at),
    });
  },
};

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
Printify	`printify`	`app`	This component uses the Printify 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.
Shop ID	`shopId`	`string`	Select a value from the drop down menu.
Webhook Topic	`topic`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

About Printify#

Sell custom t-shirts, phone cases, and 900+ products with your designs printed on demand. Printify handles printing and shipping to your customers.

Action#

Run Task Synchronously on Apify

Description:Run a specific task and return its dataset items. [See the documentation](https://docs.apify.com/api/v2/actor-task-run-sync-get-dataset-items-get)

Version:0.0.5

Key:apify-run-task-synchronously

View on GitHub

Apify Overview#

The Apify API unleashes the power to automate web scraping, process data, and orchestrate web automation workflows. By utilizing Apify on Pipedream, you can create dynamic serverless workflows to manage tasks like extracting data from websites, running browser automation, and scheduling these jobs to run autonomously. It integrates smoothly with Pipedream's capabilities to trigger actions on various other apps, store the results, and manage complex data flow with minimal setup.

Action Code#

import apify from "../../apify.app.mjs";
import { ACTOR_JOB_STATUSES } from "@apify/consts";

export default {
  key: "apify-run-task-synchronously",
  name: "Run Task Synchronously",
  description: "Run a specific task and return its dataset items. [See the documentation](https://docs.apify.com/api/v2/actor-task-run-sync-get-dataset-items-get)",
  version: "0.0.5",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    apify,
    taskId: {
      propDefinition: [
        apify,
        "taskId",
      ],
      description: "The ID of the task to run",
    },
    timeout: {
      type: "integer",
      label: "Timeout",
      description: "Optional timeout for the run, in seconds. By default, the run uses a timeout specified in the task settings.",
      optional: true,
    },
    memory: {
      type: "integer",
      label: "Memory",
      description: "Memory limit for the run, in megabytes. The amount of memory can be set to a power of 2 with a minimum of 128. By default, the run uses a memory limit specified in the task settings.",
      optional: true,
    },
    build: {
      type: "string",
      label: "Build",
      description: "Specifies the Actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the task settings (typically latest).",
      optional: true,
    },
    // Retrieve dataset output option
    clean: {
      propDefinition: [
        apify,
        "clean",
      ],
    },
    fields: {
      propDefinition: [
        apify,
        "fields",
      ],
    },
    omit: {
      propDefinition: [
        apify,
        "omit",
      ],
    },
    flatten: {
      propDefinition: [
        apify,
        "flatten",
      ],
    },
    limit: {
      propDefinition: [
        apify,
        "limit",
      ],
    },
  },
  async run({ $ }) {
    const {
      status,
      id,
      actId,
      startedAt,
      finishedAt,
      options: { build },
      buildId,
      defaultKeyValueStoreId,
      defaultDatasetId,
      defaultRequestQueueId,
      consoleUrl,
    } = await this.apify.runTaskSynchronously({
      taskId: this.taskId,
      params: {
        timeout: this.timeout,
        memory: this.memory,
        build: this.build,
      },
    });

    if (status !== ACTOR_JOB_STATUSES.SUCCEEDED) {
      throw new Error(`Run has finished with status: ${status}. Inspect it here: ${consoleUrl}`);
    }

    const { items } = await this.apify.listDatasetItems({
      datasetId: defaultDatasetId,
      params: {
        clean: this.clean,
        fields: this.fields,
        omit: this.omit,
        flatten: this.flatten,
        limit: this.limit,
      },
    });

    $.export("$summary", `Run with task id ${this.taskId} finished successfully.`);
    return {
      runId: id,
      actId,
      startedAt,
      finishedAt,
      build,
      buildId,
      defaultKeyValueStoreId,
      defaultDatasetId,
      defaultRequestQueueId,
      items,
    };
  },
};

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
Apify	`apify`	`app`	This component uses the Apify app.
Task ID	`taskId`	`string`	Select a value from the drop down menu.
Timeout	`timeout`	`integer`	Optional timeout for the run, in seconds. By default, the run uses a timeout specified in the task settings.
Memory	`memory`	`integer`	Memory limit for the run, in megabytes. The amount of memory can be set to a power of 2 with a minimum of 128. By default, the run uses a memory limit specified in the task settings.
Build	`build`	`string`	Specifies the Actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the task settings (typically latest).
Clean	`clean`	`boolean`	Return only non-empty items and skips hidden fields (i.e. fields starting with the # character)
Fields	`fields`	`string[]`	An array of fields which should be picked from the items, only these fields will remain in the resulting record objects.
Omit	`omit`	`string[]`	An array of fields which should be omitted from the items
Flatten	`flatten`	`string[]`	An array of fields which should transform nested objects into flat structures. For example, with `flatten="foo"` the object `{"foo":{"bar": "hello"}}` is turned into `{"foo.bar": "hello"}`
Limit	`limit`	`integer`	The maximum number of items to return