Search Picqer Orders with Picqer API on New Topic Webhook from QStash API

Pipedream makes it easy to connect APIs for Picqer, QStash and 2,700+ other apps remarkably fast.

Trigger workflow on

New Topic Webhook from the QStash API

Next, do this

Search Picqer Orders with the Picqer 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 QStash trigger and Picqer action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Topic Webhook trigger
1. Connect your QStash account
2. Select a QStash Topic
Configure the Search Picqer Orders action
1. Connect your Picqer account
2. Optional- Configure Search
3. Optional- Configure Since ID
4. Optional- Configure Before ID
5. Optional- Configure Since Date
6. Optional- Configure Until Date
7. Optional- Select a Status
8. Optional- Configure Reference
9. Optional- Configure Email Address
10. Optional- Select a Customer ID
11. Optional- Select a Warehouse ID
12. Optional- Select a Fulfillment Customer ID
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 Topic Webhook on QStash

Description:Emit new events on each new QStash topic message

Version:0.0.1

Key:qstash-new-topic-webhook

View on GitHub

QStash Overview#

QStash API offers a secure, scalable, and simple way to manage message queues and defer tasks. Using this API, you can enqueue messages, schedule tasks to run after a delay, and ensure that tasks are executed exactly once, leveraging the power of serverless architecture. With Pipedream's ability to connect to a multitude of services, you can build complex workflows that trigger actions in other apps based on events in QStash, allowing you to automate cross-application business processes with ease.

Trigger Code#

import qstash from "../../qstash.app.mjs";
import { methods } from "../../common.mjs";

export default {
  name: "New Topic Webhook",
  version: "0.0.1",
  key: "qstash-new-topic-webhook",
  description: "Emit new events on each new QStash topic message",
  props: {
    qstash,
    topicId: {
      type: "string",
      label: "QStash Topic",
      description: "The QStash topic to subscribe to.",
      async options() {
        const topics = await this.qstash.listTopics({
          $: this,
        });

        return topics.map((topic) => ({
          label: topic.name,
          value: topic.topicId,
        }));
      },
    },
    http: {
      type: "$.interface.http",
      customResponse: true, // optional: defaults to false
    },
    db: "$.service.db",
  },
  type: "source",
  methods: {
    ...methods,
  },
  hooks: {
    async deploy() {
      console.log("deployment hook started");
      console.log("selected topic ID", this.topicId);
      console.log(`PD generated endpoint URL ${this.http.endpoint}`);
      const endpoint = await this.qstash.createEndpoint({
        $: this,
        topicId: this.topicId,
        endpointUrl: this.http.endpoint,
      });
      console.log("Created endpoint", endpoint);
      this.db.set("endpointId", endpoint.endpointId);
    },
    async deactivate() {
      console.log("deactivate hook started");
      const endpointId = this.db.get("endpointId");
      await this.qstash.deleteEndpoint({
        $: this,
        endpointId,
      });
      console.log(`Deleted QStash endpoint ${endpointId}`);
    },
    async activate() {
      console.log("activate hook started");

      const keys = await this.qstash.getKeys({
        $: this,
      });

      const currentSigningKey = keys.current;
      const nextSigningKey = keys.next;

      this.db.set("currentSigningKey", currentSigningKey);
      this.db.set("nextSigningKey", nextSigningKey);
      console.log("Set QStash signing keys");
    },
  },
  async run(event) {
    const signature = event.headers["upstash-signature"];
    const currentSigningKey = this.db.get("currentSigningKey");
    const nextSigningKey = this.db.get("nextSigningKey");
    const url = event.url.slice(0, -1);

    try {
      await this.verify(signature, currentSigningKey, event.rawBody, url);
    } catch (e) {
      console.log(e);
      await this.verify(signature, nextSigningKey, event.rawBody, url);
    }

    await this.$emit(
      {
        event,
      },
      {
        id: event.headers["upstash-signature"],
        summary: "New webhook received from QStash",
        ts: Date.now(),
      },
    );

    await this.http.respond({
      status: 200,
    });
  },
};

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
QStash	`qstash`	`app`	This component uses the QStash app.
QStash Topic	`topicId`	`string`	Select a value from the drop down menu.
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

Retrieve your QStash token

Open the QStash console
Copy the QSTASH_TOKEN from the Request Builder

Click REQUEST_TOKEN within the Request builder to copy the token to your clipboard

Then paste it in the field below.

About QStash#

QStash is an HTTP based messaging and scheduling solution for the serverless and edge runtimes.

Action#

Search Picqer Orders on Picqer

Description:Search for orders in Picqer. [See the documentation](https://picqer.com/en/api/orders#get-all-orders)

Version:0.0.1

Key:picqer-search-orders

View on GitHub

Action Code#

import { STATUS_OPTIONS } from "../../common/constants.mjs";
import picqer from "../../picqer.app.mjs";

export default {
  key: "picqer-search-orders",
  name: "Search Picqer Orders",
  description: "Search for orders in Picqer. [See the documentation](https://picqer.com/en/api/orders#get-all-orders)",
  version: "0.0.1",
  type: "action",
  props: {
    picqer,
    search: {
      type: "string",
      label: "Search",
      description: "Search through the fields orderid, reference, customer name and customer contact name.",
      optional: true,
    },
    sinceId: {
      type: "string",
      label: "Since ID",
      description: "Get the orders with a later idorder than given.",
      optional: true,
    },
    beforeId: {
      type: "string",
      label: "Before ID",
      description: "Get the orders with a smaller idorder than given.",
      optional: true,
    },
    sinceDate: {
      type: "string",
      label: "Since Date",
      description: "Get the orders that are added after this date and time. **Format: YYYY-MM-DD HH:MM:SS**",
      optional: true,
    },
    untilDate: {
      type: "string",
      label: "Until Date",
      description: "Get the orders that are added before this date and time. **Format: YYYY-MM-DD HH:MM:SS**",
      optional: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "Get the orders that have this status.",
      options: STATUS_OPTIONS,
      optional: true,
    },
    reference: {
      type: "string",
      label: "Reference",
      description: "Get the orders that have this value as reference.",
      optional: true,
    },
    emailAddress: {
      type: "string",
      label: "Email Address",
      description: "Get the orders that have this value as email address.",
      optional: true,
    },
    customerId: {
      propDefinition: [
        picqer,
        "customerId",
      ],
      description: "Get all orders for this customer.",
      optional: true,
    },
    warehouseId: {
      propDefinition: [
        picqer,
        "warehouseId",
      ],
      description: "Get the orders that can be delivered from this warehouse.",
      optional: true,
    },
    fulfillmentCustomerId: {
      propDefinition: [
        picqer,
        "fulfillmentCustomerId",
      ],
      description: "Get the orders for this fulfilment.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.picqer.searchOrders({
      $,
      params: {
        search: this.search,
        sinceid: this.sinceId,
        beforeid: this.beforeId,
        sincedate: this.sinceDate,
        untildate: this.untilDate,
        status: this.status,
        reference: this.reference,
        emailaddress: this.emailAddress,
        idcustomer: this.customerId,
        idwarehouse: this.warehouseId,
        idfulfilment_customer: this.fulfillmentCustomerId,
      },
    });

    $.export("$summary", `Orders found: ${response.length}`);
    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
Picqer	`picqer`	`app`	This component uses the Picqer app.
Search	`search`	`string`	Search through the fields orderid, reference, customer name and customer contact name.
Since ID	`sinceId`	`string`	Get the orders with a later idorder than given.
Before ID	`beforeId`	`string`	Get the orders with a smaller idorder than given.
Since Date	`sinceDate`	`string`	Get the orders that are added after this date and time. Format: YYYY-MM-DD HH:MM:SS
Until Date	`untilDate`	`string`	Get the orders that are added before this date and time. Format: YYYY-MM-DD HH:MM:SS
Status	`status`	`string`	Select a value from the drop down menu:`{ "label": "Concept", "value": "concept" }{ "label": "Expected", "value": "expected" }{ "label": "Processing", "value": "processing" }{ "label": "Paused", "value": "paused" }{ "label": "Completed", "value": "completed" }{ "label": "Cancelled", "value": "cancelled" }`
Reference	`reference`	`string`	Get the orders that have this value as reference.
Email Address	`emailAddress`	`string`	Get the orders that have this value as email address.
Customer ID	`customerId`	`string`	Select a value from the drop down menu.
Warehouse ID	`warehouseId`	`string`	Select a value from the drop down menu.
Fulfillment Customer ID	`fulfillmentCustomerId`	`string`	Select a value from the drop down menu.