Convert URL To LLM-Friendly Input with Jina Reader API on New Cancelled Order (Instant) from Shopify API

Pipedream makes it easy to connect APIs for Jina Reader, Shopify and 2,400+ other apps remarkably fast.

Trigger workflow on

New Cancelled Order (Instant) from the Shopify API

Next, do this

Convert URL To LLM-Friendly Input with the Jina Reader 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 Shopify trigger and Jina Reader action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Cancelled Order (Instant) trigger
1. Connect your Shopify account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
Configure the Convert URL To LLM-Friendly Input action
1. Connect your Jina Reader account
2. Optional- Configure URL
3. Optional- Select a Content Format
4. Optional- Configure Timeout
5. Optional- Configure Target Selector
6. Optional- Configure Wait For Selector
7. Optional- Configure Excluded Selector
8. Optional- Configure JSON Response
9. Optional- Configure Forward Cookie
10. Optional- Configure Proxy Server URL
11. Optional- Configure Bypass Cache
12. Optional- Configure Stream Mode
13. Optional- Configure Browser Locale
14. Optional- Configure Iframe
15. Optional- Configure Include Shadow DOM Content
16. Optional- Configure PDF File Path
17. Optional- Configure HTML File Path
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 Cancelled Order (Instant) on Shopify

Description:Emit new event each time a new order is cancelled.

Version:0.0.4

Key:shopify_developer_app-new-cancelled-order

View on GitHub

Shopify Overview#

The Shopify Admin REST & GraphQL API unleashes a myriad of possibilities to automate and enhance online store operations. It provides programmatic access to Shopify functionalities, allowing users to manage products, customers, orders, and more. Leveraging the Shopify Admin API within Pipedream, developers can create custom workflows that automate repetitive tasks, sync data across platforms, and respond dynamically to events in Shopify.

This integration can be used as a custom app on your store, or for automating actions on behalf of merchants through your Shopify app.

Looking for integrating into the Shopify Partner API for your apps, themes or referrals? Check out our Shopify Partner API integration.

Trigger Code#

import constants from "../common/constants.mjs";
import common from "../common/webhook-metafields.mjs";

export default {
  ...common,
  key: "shopify_developer_app-new-cancelled-order",
  name: "New Cancelled Order (Instant)",
  type: "source",
  description: "Emit new event each time a new order is cancelled.",
  version: "0.0.4",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTopic() {
      return constants.EVENT_TOPIC.ORDERS_CANCELLED;
    },
    generateMeta(resource) {
      const ts = Date.parse(resource.updated_at);
      return {
        id: ts,
        summary: `Order Cancelled ${resource.id}.`,
        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
Shopify	`app`	`app`	This component uses the Shopify 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.
Metafield Namespaces	`metafieldNamespaces`	`string[]`	Array of namespaces for any metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.
Private Metafield Namespaces	`privateMetafieldNamespaces`	`string[]`	Array of namespaces for any private metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.

Trigger Authentication#

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

Get your Access Token

Create a custom app in Shopify to obtain your Admin API access token. See our detailed instructions here.

Enter your Admin API access token below, and save it in a secure location (we recommend using a password manager such as 1Password)

About Shopify#

Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.

Action#

Convert URL To LLM-Friendly Input on Jina Reader

Description:Converts a provided URL to an LLM-friendly input using Jina Reader. [See the documentation](https://github.com/jina-ai/reader)

Version:0.0.1

Key:jina_reader-convert-to-llm-friendly-input

View on GitHub

Action Code#

import fs from "fs";
import path from "path";
import { ConfigurationError } from "@pipedream/platform";
import app from "../../jina_reader.app.mjs";

export default {
  key: "jina_reader-convert-to-llm-friendly-input",
  name: "Convert URL To LLM-Friendly Input",
  description: "Converts a provided URL to an LLM-friendly input using Jina Reader. [See the documentation](https://github.com/jina-ai/reader)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    url: {
      type: "string",
      label: "URL",
      description: "The URL to convert to an LLM-friendly input.",
      optional: true,
    },
    contentFormat: {
      type: "string",
      label: "Content Format",
      description: "You can control the level of detail in the response to prevent over-filtering. The default pipeline is optimized for most websites and LLM input.",
      optional: true,
      options: [
        "markdown",
        "html",
        "text",
        "screenshot",
        "pageshot",
      ],
    },
    timeout: {
      type: "integer",
      label: "Timeout",
      description: "Maximum time to wait for the webpage to load. Note that this is NOT the total time for the whole end-to-end request.",
      optional: true,
    },
    targetSelector: {
      type: "string",
      label: "Target Selector",
      description: "Provide a list of CSS selector to focus on more specific parts of the page. Useful when your desired content doesn't show under the default settings. E.g., `body, .class, #id`.",
      optional: true,
    },
    waitForSelector: {
      type: "string",
      label: "Wait For Selector",
      description: "Provide a list of CSS selector to wait for specific elements to appear before returning. Useful when your desired content doesn't show under the default settings. E.g., `body, .class, #id`.",
      optional: true,
    },
    excludedSelector: {
      type: "string",
      label: "Excluded Selector",
      description: "Provide a list of CSS selector to remove the specified elements of the page. Useful when you want to exclude specific parts of the page like headers, footers, etc. E.g., `header, .class, #id`.",
      optional: true,
    },
    jsonResponse: {
      type: "boolean",
      label: "JSON Response",
      description: "The response will be in JSON format, containing the URL, title, content, and timestamp (if available). In Search mode, it returns a list of five entries, each following the described JSON structure. Keep in mind **JSON Response** will take piority over **Stream mode** if both are enabled.",
      optional: true,
    },
    forwardCookie: {
      type: "string",
      label: "Forward Cookie",
      description: "The API server can forward your custom cookie settings when accessing the URL, which is useful for pages requiring extra authentication. Note that requests with cookies will not be cached. E.g., `<cookie-name>=<cookie-value>, <cookie-name-1>=<cookie-value>; domain=<cookie-1-domain>`. [Learn more here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie).",
      optional: true,
    },
    useProxyServer: {
      type: "string",
      label: "Proxy Server URL",
      description: "The API server can utilize your proxy to access URLs, which is helpful for pages accessible only through specific proxies. E.g., `http://your_proxy_server.com`. [Learn more here](https://en.wikipedia.org/wiki/Proxy_server).",
      optional: true,
    },
    bypassCache: {
      type: "boolean",
      label: "Bypass Cache",
      description: "The API server caches both Read and Search mode contents for a certain amount of time. To bypass this cache, set this header to `true`.",
      optional: true,
    },
    streamMode: {
      type: "boolean",
      label: "Stream Mode",
      description: "Stream mode is beneficial for large target pages, allowing more time for the page to fully render. If standard mode results in incomplete content, consider using **Stream mode**. [Learn more here](https://github.com/jina-ai/reader?tab=readme-ov-file#streaming-mode). Keep in mind **JSON Response** will take piority over **Stream mode** if both are enabled.",
      optional: true,
    },
    browserLocale: {
      type: "string",
      label: "Browser Locale",
      description: "Control the browser locale to render the page. eg. `en-US`. [Learn more here](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/language).",
      optional: true,
    },
    iframeContent: {
      type: "boolean",
      label: "Iframe",
      description: "Returning result will also include the content of the iframes on the page.",
      optional: true,
    },
    shadowDomContent: {
      type: "boolean",
      label: "Include Shadow DOM Content",
      description: "Returning result will also include the content of the shadow DOM on the page.",
      optional: true,
    },
    pdf: {
      type: "string",
      label: "PDF File Path",
      description: "The path to the pdf file saved to the `/tmp` directory (e.g. `/tmp/example.pdf`). [See the documentation](https://pipedream.com/docs/workflows/steps/code/nodejs/working-with-files/#the-tmp-directory).",
      optional: true,
    },
    html: {
      type: "string",
      label: "HTML File Path",
      description: "The path to the html file saved to the `/tmp` directory (e.g. `/tmp/example.html`). [See the documentation](https://pipedream.com/docs/workflows/steps/code/nodejs/working-with-files/#the-tmp-directory).",
      optional: true,
    },
  },
  methods: {
    async readFileFromTmp(filePath, encoding) {
      if (!filePath) {
        return;
      }
      const resolvedPath = path.resolve(filePath);
      if (!resolvedPath.startsWith("/tmp/")) {
        throw new ConfigurationError(`${filePath} must be located in the '/tmp/' directory`);
      }
      return await fs.promises.readFile(resolvedPath, encoding);
    },
  },
  async run({ $ }) {
    const {
      app,
      readFileFromTmp,
      url,
      contentFormat,
      timeout,
      targetSelector,
      waitForSelector,
      excludedSelector,
      jsonResponse,
      forwardCookie,
      useProxyServer,
      bypassCache,
      streamMode,
      browserLocale,
      iframeContent,
      shadowDomContent,
      pdf,
      html,
    } = this;

    if (!url && !pdf && !html) {
      throw new ConfigurationError("You must provide at least one of **URL**, **PDF File Path**, or **HTML File Path**.");
    }

    const response = await app.post({
      $,
      headers: {
        "X-Return-Format": contentFormat,
        "X-Timeout": timeout,
        "X-Target-Selector": targetSelector,
        "X-Wait-For-Selector": waitForSelector,
        "X-Remove-Selector": excludedSelector,
        "X-Set-Cookie": forwardCookie,
        "X-Proxy-Url": useProxyServer,
        "X-No-Cache": bypassCache,
        "Accept": jsonResponse
          ? "application/json"
          : streamMode
            ? "text/event-stream"
            : undefined,
        "X-Locale": browserLocale,
        "X-With-Shadow-Dom": shadowDomContent,
        "X-Iframe": iframeContent,
      },
      data: {
        url,
        pdf: await readFileFromTmp(pdf, "base64"),
        html: await readFileFromTmp(html, "utf-8"),
      },
    });

    $.export("$summary", "Converted URL to LLM-friendly input successfully.");
    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
Jina Reader	`app`	`app`	This component uses the Jina Reader app.
URL	`url`	`string`	The URL to convert to an LLM-friendly input.
Content Format	`contentFormat`	`string`	Select a value from the drop down menu:`markdownhtmltextscreenshotpageshot`
Timeout	`timeout`	`integer`	Maximum time to wait for the webpage to load. Note that this is NOT the total time for the whole end-to-end request.
Target Selector	`targetSelector`	`string`	Provide a list of CSS selector to focus on more specific parts of the page. Useful when your desired content doesn't show under the default settings. E.g., `body, .class, #id`.
Wait For Selector	`waitForSelector`	`string`	Provide a list of CSS selector to wait for specific elements to appear before returning. Useful when your desired content doesn't show under the default settings. E.g., `body, .class, #id`.
Excluded Selector	`excludedSelector`	`string`	Provide a list of CSS selector to remove the specified elements of the page. Useful when you want to exclude specific parts of the page like headers, footers, etc. E.g., `header, .class, #id`.
JSON Response	`jsonResponse`	`boolean`	The response will be in JSON format, containing the URL, title, content, and timestamp (if available). In Search mode, it returns a list of five entries, each following the described JSON structure. Keep in mind JSON Response will take piority over Stream mode if both are enabled.
Forward Cookie	`forwardCookie`	`string`	The API server can forward your custom cookie settings when accessing the URL, which is useful for pages requiring extra authentication. Note that requests with cookies will not be cached. E.g., `<cookie-name>=<cookie-value>, <cookie-name-1>=<cookie-value>; domain=<cookie-1-domain>`. Learn more here.
Proxy Server URL	`useProxyServer`	`string`	The API server can utilize your proxy to access URLs, which is helpful for pages accessible only through specific proxies. E.g., `http://your_proxy_server.com`. Learn more here.
Bypass Cache	`bypassCache`	`boolean`	The API server caches both Read and Search mode contents for a certain amount of time. To bypass this cache, set this header to `true`.
Stream Mode	`streamMode`	`boolean`	Stream mode is beneficial for large target pages, allowing more time for the page to fully render. If standard mode results in incomplete content, consider using Stream mode. Learn more here. Keep in mind JSON Response will take piority over Stream mode if both are enabled.
Browser Locale	`browserLocale`	`string`	Control the browser locale to render the page. eg. `en-US`. Learn more here.
Iframe	`iframeContent`	`boolean`	Returning result will also include the content of the iframes on the page.
Include Shadow DOM Content	`shadowDomContent`	`boolean`	Returning result will also include the content of the shadow DOM on the page.
PDF File Path	`pdf`	`string`	The path to the pdf file saved to the `/tmp` directory (e.g. `/tmp/example.pdf`). See the documentation.
HTML File Path	`html`	`string`	The path to the html file saved to the `/tmp` directory (e.g. `/tmp/example.html`). See the documentation.