Chat With Document with AskYourPDF API on New Event Emitted (Instant) from Shopify API

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

Trigger workflow on

New Event Emitted (Instant) from the Shopify API

Next, do this

Chat With Document with the AskYourPDF 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 AskYourPDF action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Event Emitted (Instant) trigger
1. Connect your Shopify account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
4. Select a Event Topic
Configure the Chat With Document action
1. Connect your AskYourPDF account
2. Configure Document ID
3. Configure Sender
4. Configure Message
5. Optional- Configure Stream
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 Event Emitted (Instant) on Shopify

Description:Emit new event for each new Shopify event.

Version:0.0.4

Key:shopify_developer_app-new-event-emitted

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-event-emitted",
  name: "New Event Emitted (Instant)",
  type: "source",
  description: "Emit new event for each new Shopify event.",
  version: "0.0.4",
  dedupe: "unique",
  props: {
    ...common.props,
    topic: {
      type: "string",
      label: "Event Topic",
      description: "Event topic that triggers the webhook.",
      options: constants.EVENT_TOPICS,
    },
  },
  methods: {
    ...common.methods,
    getTopic() {
      return this.topic;
    },
    generateMeta() {
      const ts = Date.now();
      return {
        id: ts,
        summary: `New Event Emitted at ${new Date(ts)}.`,
        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`.
Event Topic	`topic`	`string`	Select a value from the drop down menu:`app/uninstalledbulk_operations/finishcarts/createcarts/updatecheckouts/createcheckouts/deletecheckouts/updatecollection_listings/addcollection_listings/removecollection_listings/updatecollections/createcollections/deletecollections/updatecustomer_groups/createcustomer_groups/deletecustomer_groups/updatecustomer_payment_methods/createcustomer_payment_methods/revokecustomer_payment_methods/updatecustomers_marketing_consent/updatecustomers/createcustomers/deletecustomers/disablecustomers/enablecustomers/updatedisputes/createdisputes/updatedomains/createdomains/destroydomains/updatedraft_orders/createdraft_orders/deletedraft_orders/updatefulfillment_events/createfulfillment_events/deletefulfillments/createfulfillments/updateinventory_items/createinventory_items/deleteinventory_items/updateinventory_levels/connectinventory_levels/disconnectinventory_levels/updatelocales/createlocales/updatelocations/createlocations/deletelocations/updatemarkets/createmarkets/deletemarkets/updateorder_transactions/createorders/cancelledorders/createorders/deleteorders/editedorders/fulfilledorders/paidorders/partially_fulfilledorders/updatedproduct_listings/addproduct_listings/removeproduct_listings/updateproducts/createproducts/deleteproducts/updateprofiles/createprofiles/deleteprofiles/updaterefunds/createscheduled_product_listings/addscheduled_product_listings/removescheduled_product_listings/updateselling_plan_groups/createselling_plan_groups/deleteselling_plan_groups/updateshop/updatesubscription_billing_attempts/challengedsubscription_billing_attempts/failuresubscription_billing_attempts/successsubscription_contracts/createsubscription_contracts/updatetender_transactions/createthemes/createthemes/deletethemes/publishevent-topics-themes-updatethemes/update`

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#

Chat With Document on AskYourPDF

Description:Chat with a document. [See the documentation](https://docs.askyourpdf.com/askyourpdf-docs/#3.-chat-endpoint)

Version:0.0.2

Key:askyourpdf-chat-with-document

View on GitHub

AskYourPDF Overview#

AskYourPDF API allows you to extract text and data from PDF files programmatically. On Pipedream, leverage this API to automate workflows involving PDF data extraction, such as parsing invoices, extracting data for reports, or importing information into a database. With Pipedream's ability to integrate with various apps, you can create workflows that trigger on specific events and handle extracted PDF data with custom logic and actions.

Action Code#

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

export default {
  key: "askyourpdf-chat-with-document",
  name: "Chat With Document",
  description: "Chat with a document. [See the documentation](https://docs.askyourpdf.com/askyourpdf-docs/#3.-chat-endpoint)",
  type: "action",
  version: "0.0.2",
  props: {
    app,
    docId: {
      type: "string",
      label: "Document ID",
      description: "The ID of the document for the conversation.",
    },
    sender: {
      type: "string",
      label: "Sender",
      description: "The sender of the chat message. The sender should be `user`.",
      default: "user",
    },
    message: {
      type: "string",
      label: "Message",
      description: "The chat message content.",
    },
    stream: {
      type: "boolean",
      label: "Stream",
      description: "Flag for streaming. Default is false",
      optional: true,
      default: false,
    },
  },
  methods: {
    chatWithDocument({
      docId, ...args
    } = {}) {
      return this.app.post({
        path: `/chat/${docId}`,
        ...args,
      });
    },
  },
  run({ $: step }) {
    const {
      // eslint-disable-next-line no-unused-vars
      app,
      chatWithDocument,
      docId,
      sender,
      message,
      stream,
    } = this;

    return chatWithDocument({
      step,
      docId,
      data: [
        {
          sender,
          message,
        },
      ],
      params: {
        stream,
      },
      summary: (response) => `Successfully chatted with document at: \`${response.created || (new Date()).toISOString()}\``,
    });
  },
};

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
AskYourPDF	`app`	`app`	This component uses the AskYourPDF app.
Document ID	`docId`	`string`	The ID of the document for the conversation.
Sender	`sender`	`string`	The sender of the chat message. The sender should be `user`.
Message	`message`	`string`	The chat message content.
Stream	`stream`	`boolean`	Flag for streaming. Default is false

Action Authentication#

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

About AskYourPDF#

Your gateway to dynamic, interactive, and intelligent conversations with any document. 💬📚

More Ways to Connect AskYourPDF + Shopify#

Other Popular Integrations#

Chat With Document with AskYourPDF API on New Abandoned Cart from Shopify Developer App API

Shopify + AskYourPDF

Chat With Document with AskYourPDF API on New Event Emitted (Instant) from Shopify API

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

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

Developers ♥ Pipedream

Get your Access Token

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular