Create Shipping Order with Shipday API on New Message Sent from WhatsApp Business API

Pipedream makes it easy to connect APIs for Shipday, WhatsApp Business and 2,700+ other apps remarkably fast.

Trigger workflow on

New Message Sent from the WhatsApp Business API

Next, do this

Create Shipping Order with the Shipday 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 WhatsApp Business trigger and Shipday action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Message Sent trigger
1. Connect your WhatsApp Business account
Configure the Create Shipping Order action
1. Connect your Shipday account
2. Configure Order Number
3. Configure Customer Name
4. Configure Customer Address
5. Configure Customer Email
6. Configure Customer Phone Number
7. Configure Restaurant Name
8. Configure Restaurant Address
9. Optional- Configure Expected Delivery Date
10. Optional- Configure Expected Pickup Time
11. Optional- Configure Expected Delivery Time
12. Optional- Configure Pickup Latitude
13. Optional- Configure Pickup Longitude
14. Optional- Configure Delivery Latitude
15. Optional- Configure Delivery Longitude
16. Optional- Configure Tips
17. Optional- Configure Tax
18. Optional- Configure Discount Amount
19. Optional- Configure Delivery Fee
20. Optional- Configure Total Order Cost
21. Optional- Configure Pickup Instruction
22. Optional- Configure Delivery Instruction
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 Message Sent on WhatsApp Business

Description:Emit new event when a new message is sent or received. A Webhook subscribed to field "messages" must be set up from the App Dashboard of your [Facebook Developer Account](https://developers.facebook.com/). See [documentation](https://developers.facebook.com/docs/graph-api/webhooks/getting-started#configure-webhooks-product) for more information about Webhook setup.

Version:0.0.4

Key:whatsapp_business-new-message-sent

View on GitHub

WhatsApp Business Overview#

The WhatsApp Business API on Pipedream is a powerful avenue for automating interactions with customers on WhatsApp. You can send messages, set up automated responses, and manage conversations on a large scale. With Pipedream's serverless platform, you can create workflows that trigger from various events and connect WhatsApp Business with numerous other apps to automate tasks, notify teams, sync data, and more, all without managing infrastructure.

Trigger Code#

import whatsapp from "../../whatsapp_business.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "whatsapp_business-new-message-sent",
  name: "New Message Sent",
  description: "Emit new event when a new message is sent or received. A Webhook subscribed to field \"messages\" must be set up from the App Dashboard of your [Facebook Developer Account](https://developers.facebook.com/). See [documentation](https://developers.facebook.com/docs/graph-api/webhooks/getting-started#configure-webhooks-product) for more information about Webhook setup.",
  version: "0.0.4",
  type: "source",
  dedupe: "unique",
  props: {
    whatsapp,
    db: "$.service.db",
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
  },
  methods: {
    _getChallengeToken() {
      return this.db.get("challengeToken");
    },
    _setChallengeToken(challengeToken) {
      this.db.set("challengeToken", challengeToken);
    },
  },
  async run(event) {
    const {
      body, query,
    } = event;
    if (query["hub.challenge"]) {
      this._setChallengeToken(query["hub.challenge"]);
    }
    const challengeToken = this._getChallengeToken();

    this.httpInterface.respond({
      status: "200",
      body: challengeToken,
      headers: {
        "content-type": "application/json",
      },
    });

    if (!body) {
      return;
    }

    const entries = body?.entry || [];
    for (const entry of entries) {
      if (entry.changes && entry.changes?.length > 0) {
        const status = entry?.changes[0]?.value?.statuses
          ? entry?.changes[0]?.value?.statuses[0]?.status
          : null;
        if (status && status !== "sent") {
          continue;
        }
      }
      this.$emit(entry, {
        id: Date.now(),
        summary: "New Message Sent",
        ts: Date.now(),
      });
    }
  },
  sampleEmit,
};

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
WhatsApp Business	`whatsapp`	`app`	This component uses the WhatsApp Business app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`httpInterface`	`$.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.

Trigger Authentication#

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

To connect your WhatsApp Business Cloud account to Pipedream, follow the steps below to find your Business Account ID and your Permanent Access Token.

For additional info on setting up a WhatsApp Business account, refer to their getting started docs

About WhatsApp Business#

WhatsApp Business products support businesses from large to small. Engage audiences, accelerate sales and drive better customer support outcomes on the platform with more than 2 billion users around the world.

Action#

Create Shipping Order on Shipday

Description:Creates a new shipping order. [See the documentation](https://docs.shipday.com/reference/insert-delivery-order)

Version:0.0.1

Key:shipday-create-order

View on GitHub

Shipday Overview#

The Shipday API lets you manage and automate delivery operations seamlessly. By integrating with Pipedream, you can orchestrate workflows that trigger from various events, sync data between services, and automate notifications or order tracking. With Pipedream's serverless platform, you can craft custom workflows that react in real-time to changes in delivery statuses, new order placements, or updates from other integrated services. This flexibility allows businesses to enhance their delivery processes, improve customer communication, and streamline operations.

Action Code#

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

export default {
  key: "shipday-create-order",
  name: "Create Shipping Order",
  description: "Creates a new shipping order. [See the documentation](https://docs.shipday.com/reference/insert-delivery-order)",
  version: "0.0.1",
  type: "action",
  props: {
    shipday,
    orderNumber: {
      propDefinition: [
        shipday,
        "orderNumber",
      ],
    },
    customerName: {
      propDefinition: [
        shipday,
        "customerName",
      ],
    },
    customerAddress: {
      propDefinition: [
        shipday,
        "customerAddress",
      ],
    },
    customerEmail: {
      propDefinition: [
        shipday,
        "customerEmail",
      ],
    },
    customerPhoneNumber: {
      propDefinition: [
        shipday,
        "customerPhoneNumber",
      ],
    },
    restaurantName: {
      propDefinition: [
        shipday,
        "restaurantName",
      ],
    },
    restaurantAddress: {
      propDefinition: [
        shipday,
        "restaurantAddress",
      ],
    },
    expectedDeliveryDate: {
      propDefinition: [
        shipday,
        "expectedDeliveryDate",
      ],
    },
    expectedPickupTime: {
      propDefinition: [
        shipday,
        "expectedPickupTime",
      ],
    },
    expectedDeliveryTime: {
      propDefinition: [
        shipday,
        "expectedDeliveryTime",
      ],
    },
    pickupLatitude: {
      propDefinition: [
        shipday,
        "pickupLatitude",
      ],
    },
    pickupLongitude: {
      propDefinition: [
        shipday,
        "pickupLongitude",
      ],
    },
    deliveryLatitude: {
      propDefinition: [
        shipday,
        "deliveryLatitude",
      ],
    },
    deliveryLongitude: {
      propDefinition: [
        shipday,
        "deliveryLongitude",
      ],
    },
    tips: {
      propDefinition: [
        shipday,
        "tips",
      ],
    },
    tax: {
      propDefinition: [
        shipday,
        "tax",
      ],
    },
    discountAmount: {
      propDefinition: [
        shipday,
        "discountAmount",
      ],
    },
    deliveryFee: {
      propDefinition: [
        shipday,
        "deliveryFee",
      ],
    },
    totalOrderCost: {
      propDefinition: [
        shipday,
        "totalOrderCost",
      ],
    },
    pickupInstruction: {
      propDefinition: [
        shipday,
        "pickupInstruction",
      ],
    },
    deliveryInstruction: {
      propDefinition: [
        shipday,
        "deliveryInstruction",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.shipday.createShippingOrder({
      data: {
        orderNumber: this.orderNumber,
        customerName: this.customerName,
        customerAddress: this.customerAddress,
        customerEmail: this.customerEmail,
        customerPhoneNumber: this.customerPhoneNumber,
        restaurantName: this.restaurantName,
        restaurantAddress: this.restaurantAddress,
        expectedDeliveryDate: this.expectedDeliveryDate,
        expectedPickupTime: this.expectedPickupTime,
        expectedDeliveryTime: this.expectedDeliveryTime,
        pickupLatitude: this.pickupLatitude,
        pickupLongitude: this.pickupLongitude,
        deliveryLatitude: this.deliveryLatitude,
        deliveryLongitude: this.deliveryLongitude,
        tips: this.tips,
        tax: this.tax,
        discountAmount: this.discountAmount,
        deliveryFee: this.deliveryFee,
        totalOrderCost: this.totalOrderCost,
        pickupInstruction: this.pickupInstruction,
        deliveryInstruction: this.deliveryInstruction,
      },
    });
    if (response?.orderId) {
      $.export("$summary", `Successfully created shipping order with ID: ${response.orderId}`);
    }
    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
Shipday	`shipday`	`app`	This component uses the Shipday app.
Order Number	`orderNumber`	`string`	Alphanumeric identifier for the order object
Customer Name	`customerName`	`string`	The name of the customer
Customer Address	`customerAddress`	`string`	The address of the customer
Customer Email	`customerEmail`	`string`	The email address of the customer
Customer Phone Number	`customerPhoneNumber`	`string`	Phone number of the customer with country code
Restaurant Name	`restaurantName`	`string`	The name of the restaurant
Restaurant Address	`restaurantAddress`	`string`	The address of the restaurant
Expected Delivery Date	`expectedDeliveryDate`	`string`	Expected delivery date in UTC for the particular order ( yyyy-mm-dd format)
Expected Pickup Time	`expectedPickupTime`	`string`	Expected pickup time in UTC for the particular order (format hh:mm:ss)
Expected Delivery Time	`expectedDeliveryTime`	`string`	Expected Delivery Time in UTC for the particular order (format hh:mm:ss)
Pickup Latitude	`pickupLatitude`	`string`	The latitude of the pickup location
Pickup Longitude	`pickupLongitude`	`string`	The longitude of the pickup location
Delivery Latitude	`deliveryLatitude`	`string`	The latitude of the delivery location
Delivery Longitude	`deliveryLongitude`	`string`	The longitude of the delivery location
Tips	`tips`	`string`	Tips amount for the order
Tax	`tax`	`string`	The tax for the order
Discount Amount	`discountAmount`	`string`	The discount amount for the order
Delivery Fee	`deliveryFee`	`string`	The delivery fee for the order
Total Order Cost	`totalOrderCost`	`string`	The total cost of the order
Pickup Instruction	`pickupInstruction`	`string`	The pickup instructions for the order
Delivery Instruction	`deliveryInstruction`	`string`	The delivery instructions for the order