Create Order with BaseLinker API on New Events (Instant) from Twilio SendGrid API

Pipedream makes it easy to connect APIs for BaseLinker, Twilio SendGrid and 2,400+ other apps remarkably fast.

Trigger workflow on

New Events (Instant) from the Twilio SendGrid API

Next, do this

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

Select this integration
Configure the New Events (Instant) trigger
1. Connect your Twilio SendGrid account
2. Select one or more Event Types
Configure the Create Order action
1. Connect your BaseLinker account
2. Select a Order Status ID
3. Optional- Select a Inventory ID
4. Optional- Configure Currency
5. Optional- Configure Payment Method
6. Optional- Configure Payment Method COD
7. Optional- Configure Paid
8. Optional- Configure Buyer Comments
9. Optional- Configure Seller Comments
10. Optional- Configure Email
11. Optional- Configure Want Invoice
12. Configure Number Of Products
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 Events (Instant) on Twilio SendGrid

Description:Emit new event when any of the specified SendGrid events is received

Version:0.0.6

Key:sendgrid-events

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to hundreds of other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Trigger Code#

import common from "../common/http-based.mjs";
import deliveryEventTypes from "./delivery-event-types.mjs";
import engagementEventTypes from "./engagement-event-types.mjs";

export default {
  ...common,
  key: "sendgrid-events",
  name: "New Events (Instant)",
  description: "Emit new event when any of the specified SendGrid events is received",
  version: "0.0.6",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    eventTypes: {
      type: "string[]",
      label: "Event Types",
      description: "The type of events to listen to",
      options(context) {
        const { page } = context;
        if (page !== 0) {
          return {
            options: [],
          };
        }

        const options = [
          ...deliveryEventTypes,
          ...engagementEventTypes,
        ];
        return {
          options,
        };
      },
    },
  },
  methods: {
    ...common.methods,
    baseWebhookSettings() {
      // The list of events that a webhook can listen to. This method returns an
      // exhaustive list of all such flags disabled, and each event source can
      // then override the flags that are relevant to the event they handle.
      //
      // See the docs for more information:
      // https://sendgrid.com/docs/api-reference/
      const eventTypesData = [
        ...deliveryEventTypes,
        ...engagementEventTypes,
      ];
      return eventTypesData.reduce((accum, eventTypeData) => ({
        ...accum,
        [eventTypeData.value]: false,
      }), {});
    },
    webhookEventFlags() {
      return this.eventTypes.reduce((accum, eventType) => ({
        ...accum,
        [eventType]: true,
      }), {});
    },
    generateMeta(data) {
      const {
        event: eventType,
        sg_event_id: id,
        timestamp: ts,
      } = data;
      const summary = `New event: ${eventType}`;
      return {
        id,
        summary,
        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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid app.
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.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

About Twilio SendGrid#

Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.

Action#

Create Order on BaseLinker

Description:It allows adding a new order to the BaseLinker order manager. [See the Documentation](https://api.baselinker.com/index.php?method=addOrder).

Version:0.0.1

Key:baselinker-create-order

View on GitHub

BaseLinker Overview#

The BaseLinker API offers access to a suite of e-commerce management tools, enabling seamless integration of orders, products, and inventory across various online sales channels. With Pipedream's ability to connect APIs, you can automate tasks between BaseLinker and other apps to streamline your e-commerce operations, from syncing inventory to processing orders.

Action Code#

import app from "../../baselinker.app.mjs";
import constants from "../../common/constants.mjs";
import method from "../../common/method.mjs";

export default {
  key: "baselinker-create-order",
  name: "Create Order",
  description: "It allows adding a new order to the BaseLinker order manager. [See the Documentation](https://api.baselinker.com/index.php?method=addOrder).",
  type: "action",
  version: "0.0.1",
  props: {
    app,
    orderStatusId: {
      propDefinition: [
        app,
        "orderStatusId",
      ],
    },
    inventoryId: {
      optional: true,
      description: "The ID of the inventory in which the products are located. If the inventory ID is not provided, the products will be searched in the **default** inventory.",
      propDefinition: [
        app,
        "inventoryId",
      ],
    },
    currency: {
      optional: true,
      propDefinition: [
        app,
        "currency",
      ],
    },
    paymentMethod: {
      type: "string",
      label: "Payment Method",
      description: "The payment method of the order.",
      optional: true,
    },
    paymentMethodCOD: {
      type: "boolean",
      label: "Payment Method COD",
      description: "Flag indicating whether the type of payment is COD (cash on delivery)",
      optional: true,
    },
    paid: {
      type: "boolean",
      label: "Paid",
      description: "Information whether the order is already paid. The value `1` automatically adds a full payment to the order.",
      optional: true,
    },
    userComments: {
      type: "string",
      label: "Buyer Comments",
      description: "Comments added by the customer when placing the order.",
      optional: true,
    },
    adminComments: {
      type: "string",
      label: "Seller Comments",
      description: "Comments added by the seller to the order.",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "The email address of the customer who placed the order.",
      optional: true,
    },
    wantInvoice: {
      type: "boolean",
      label: "Want Invoice",
      description: "Flag indicating whether the customer wants to receive an invoice.",
      optional: true,
    },
    numberOfProducts: {
      type: "integer",
      label: "Number Of Products",
      description: "The number of products in the order.",
      default: 1,
      reloadProps: true,
    },
  },
  async additionalProps() {
    return Array.from({
      length: this.numberOfProducts,
    }).reduce((acc, _, index) => {
      const {
        prefix,
        description,
      } = this.getPrefixAndDesc(index);

      return {
        ...acc,
        [`${prefix}name`]: {
          type: "string",
          label: `${description} Name`,
          description: `${description} The name of the product.`,
          optional: true,
        },
        [`${prefix}sku`]: {
          type: "string",
          label: `${description} SKU`,
          description: `${description} The SKU of the product.`,
          optional: true,
        },
        [`${prefix}quantity`]: {
          type: "integer",
          label: `${description} Quantity`,
          description: `${description} The quantity of the product.`,
          optional: true,
        },
        [`${prefix}storage`]: {
          type: "string",
          label: `${description} Storage`,
          description: `${description} Type of magazine from which the product comes.`,
          options: Object.values(constants.STORAGE),
          optional: true,
        },
        [`${prefix}productId`]: {
          type: "string",
          label: `${description} Product ID`,
          description: `${description} The ID of the product.`,
          optional: true,
          options: async ({ page }) => {
            let inventoryId = this.inventoryId;

            if (!inventoryId) {
              const {
                inventories: [
                  inventory,
                ],
              } = await this.app.listInventories();
              inventoryId = inventory?.inventory_id;
            }

            const response = await this.app.listInventoryProducts({
              data: {
                parameters: {
                  page,
                  inventory_id: inventoryId,
                },
              },
            });
            return Object.entries(response.products)
              .map(([
                , {
                  id: value, name: label,
                },
              ]) => ({
                label,
                value,
              }));
          },
        },
      };
    }, {});
  },
  methods: {
    getPrefixAndDesc(index) {
      const productIdx = index + 1;
      return {
        prefix: `product${productIdx}${constants.SEP}`,
        description: `Product ${productIdx} -`,
      };
    },
    getProduct(index) {
      const { prefix } = this.getPrefixAndDesc(index);
      const {
        [`${prefix}name`]: name,
        [`${prefix}sku`]: sku,
        [`${prefix}quantity`]: quantity,
        [`${prefix}storage`]: storage,
        [`${prefix}productId`]: product_id,
      } = this;
      return {
        name,
        sku,
        quantity,
        storage,
        product_id,
      };
    },
    getProducts() {
      return Array.from({
        length: this.numberOfProducts,
      }).map((_, index) => this.getProduct(index));
    },
    createOrder(args = {}) {
      return this.app.connector({
        ...args,
        data: {
          method: method.ADD_ORDER,
          ...args.data,
        },
      });
    },
  },
  async run({ $: step }) {
    const {
      orderStatusId,
      currency,
      paymentMethod,
      paymentMethodCOD,
      paid,
      userComments,
      adminComments,
      email,
      wantInvoice,
    } = this;

    const response = await this.createOrder({
      data: {
        parameters: {
          order_status_id: orderStatusId,
          currency,
          payment_method: paymentMethod,
          payment_method_cod: paymentMethodCOD,
          paid,
          user_comments: userComments,
          admin_comments: adminComments,
          email,
          want_invoice: wantInvoice,
          products: this.getProducts(),
        },
      },
    });

    step.export("$summary", `Successfully created order ${response.order_id}.`);

    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
BaseLinker	`app`	`app`	This component uses the BaseLinker app.
Order Status ID	`orderStatusId`	`string`	Select a value from the drop down menu.
Inventory ID	`inventoryId`	`string`	Select a value from the drop down menu.
Currency	`currency`	`string`	3-letter currency symbol (e.g. `EUR`, `PLN`)
Payment Method	`paymentMethod`	`string`	The payment method of the order.
Payment Method COD	`paymentMethodCOD`	`boolean`	Flag indicating whether the type of payment is COD (cash on delivery)
Paid	`paid`	`boolean`	Information whether the order is already paid. The value `1` automatically adds a full payment to the order.
Buyer Comments	`userComments`	`string`	Comments added by the customer when placing the order.
Seller Comments	`adminComments`	`string`	Comments added by the seller to the order.
Email	`email`	`string`	The email address of the customer who placed the order.
Want Invoice	`wantInvoice`	`boolean`	Flag indicating whether the customer wants to receive an invoice.
Number Of Products	`numberOfProducts`	`integer`	The number of products in the order.

Action Authentication#

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

To retrieve your API key,