Create Customer Order with Allocadence API on New Contact from Twilio SendGrid API

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

Trigger workflow on

New Contact from the Twilio SendGrid API

Next, do this

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

Select this integration
Configure the New Contact trigger
1. Connect your Twilio SendGrid account
2. Configure timer
Configure the Create Customer Order action
1. Connect your Allocadence account
2. Optional- Configure Order Number
3. Optional- Configure Client Id
4. Optional- Configure Client Name
5. Optional- Configure Customer Id
6. Optional- Configure Customer Title
7. Optional- Configure Customer Name
8. Optional- Configure Customer Surname
9. Optional- Configure Customer Email
10. Optional- Configure Customer Company
11. Optional- Configure Customer Account Number
12. Optional- Configure Shipping Address Id
13. Optional- Configure Shipping Address Code
14. Optional- Configure Shipping Address Company
15. Optional- Configure Shipping Address Name
16. Optional- Configure Shipping Address Line 1
17. Optional- Configure Shipping Address Line 2
18. Optional- Configure Shipping Address Line 3
19. Optional- Configure Shipping Address City
20. Optional- Configure Shipping Address State
21. Optional- Configure Shipping Address Zip
22. Optional- Configure Shipping Address Country Code
23. Optional- Configure Shipping Address Phone
24. Optional- Configure Same As Shipping
25. Optional- Configure Ship From Warehouse Id
26. Optional- Configure Ship From Warehouse Name
27. Optional- Configure Ship Via
28. Optional- Select a Postage Account
29. Optional- Configure Items
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 Contact on Twilio SendGrid

Description:Emit new event when a new contact is created

Version:0.0.7

Key:sendgrid-new-contact

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 orderBy from "lodash/orderBy.js";
import common from "../common/timer-based.mjs";

export default {
  ...common,
  key: "sendgrid-new-contact",
  name: "New Contact",
  description: "Emit new event when a new contact is created",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  hooks: {
    async activate() {
      const currentTimestamp = Date.now();
      const state = {
        processedItems: [],
        lowerTimestamp: currentTimestamp,
        upperTimestamp: currentTimestamp,
      };
      this.db.set("state", state);
    },
  },
  methods: {
    ...common.methods,
    _maxDelayTime() {
      // There is no report from SendGrid as to how much time it takes
      // for a contact to be created and appear in search results, so
      // we're using a rough estimate of 30 minutes here.
      return 30 * 60 * 1000;  // 30 minutes, in milliseconds
    },
    _addDelayOffset(timestamp) {
      return timestamp - this._maxDelayTime();
    },
    _cleanupOldProcessedItems(processedItems, currentTimestamp) {
      return processedItems
        .map((item) => ({
          // We just need to keep track of the record ID and
          // its creation date.
          id: item.id,
          created_at: item.created_at,
        }))
        .filter((item) => {
          const { created_at: createdAt } = item;
          const createdAtTimestamp = Date.parse(createdAt);
          const cutoffTimestamp = this._addDelayOffset(currentTimestamp);
          return createdAtTimestamp > cutoffTimestamp;
        });
    },
    _makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp) {
      const idList = processedItems
        .map((item) => item.id)
        .map((id) => `'${id}'`)
        .join(", ")
      || "''";
      const startTimestamp = this._addDelayOffset(lowerTimestamp);
      const startDate = this.toISOString(startTimestamp);
      const endDate = this.toISOString(upperTimestamp);
      return `
        contact_id NOT IN (${idList}) AND
        created_at BETWEEN
          TIMESTAMP '${startDate}' AND
          TIMESTAMP '${endDate}'
      `;
    },
    generateMeta(data) {
      const {
        item,
        eventTimestamp: ts,
      } = data;
      const {
        id,
        email,
      } = item;
      const slugifiedEmail = this.slugifyEmail(email);
      const summary = `New contact: ${slugifiedEmail}`;
      return {
        id,
        summary,
        ts,
      };
    },
    async processEvent(event) {
      // Transform the timer timestamp to milliseconds
      // to be consistent with how Javascript handles timestamps.
      const eventTimestamp = event.timestamp * 1000;

      // Retrieve the current state of the component.
      const {
        processedItems,
        lowerTimestamp,
        upperTimestamp,
      } = this.db.get("state");

      // Search for contacts within a specific timeframe, excluding
      // items that have already been processed.
      const query = this._makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp);
      const {
        result: items,
        contact_count: contactCount,
      } = await this.sendgrid.searchContacts(query);

      // If no contacts have been retrieved via the API,
      // move the time window forward to possibly capture newer contacts.
      if (contactCount === 0) {
        const newState = {
          processedItems: this._cleanupOldProcessedItems(processedItems, lowerTimestamp),
          lowerTimestamp: upperTimestamp,
          upperTimestamp: eventTimestamp,
        };
        this.db.set("state", newState);
        return;
      }

      // We process the searched records from oldest to newest.
      const itemsToProcess = orderBy(items, "created_at");
      itemsToProcess
        .forEach((item) => {
          const meta = this.generateMeta({
            item,
            eventTimestamp,
          });
          this.$emit(item, meta);
        });

      // Use the timestamp of the last processed record as a lower bound for
      // following searches. This bound will be subjected to an offset so in
      // case older records appear in future search results, but have not
      // appeared until now, can be processed. We only adjust it if it means
      // moving forward, not backwards. Otherwise, we might start retrieving
      // older and older records indefinitely (and we're all about *new*
      // records!)
      const newLowerTimestamp = Math.max(
        lowerTimestamp,
        Date.parse(itemsToProcess[0].created_at),
      );

      // If the total contact count is less than 100, it means that during the
      // next iteration the search results count will most likely be less than
      // 50. In that case, if we extend the upper bound of the search time range
      // we might be able to retrieve more records.
      const newUpperTimestamp = contactCount < 100
        ? eventTimestamp
        : upperTimestamp;

      // The list of processed items can grow indefinitely.
      // Since we don't want to keep track of every processed record
      // ever, we need to clean up this list, removing any records
      // that are no longer relevant.
      const newProcessedItems = this._cleanupOldProcessedItems(
        [
          ...processedItems,
          ...itemsToProcess,
        ],
        newLowerTimestamp,
      );

      // Update the state of the component to reflect the computations
      // made above.
      const newState = {
        processedItems: newProcessedItems,
        lowerTimestamp: newLowerTimestamp,
        upperTimestamp: newUpperTimestamp,
      };
      this.db.set("state", newState);
    },
  },
};

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.
	`timer`	`$.interface.timer`

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 Customer Order on Allocadence

Description:Creates a new customer order. [See the documentation](https://docs.allocadence.com/#tag/customer_order/paths/~1customer-orders/post)

Version:0.0.1

Key:allocadence-create-customer-order

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import allocadence from "../../allocadence.app.mjs";
import { POSTAGE_ACCOUNT_OPTIONS } from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";

export default {
  key: "allocadence-create-customer-order",
  name: "Create Customer Order",
  description: "Creates a new customer order. [See the documentation](https://docs.allocadence.com/#tag/customer_order/paths/~1customer-orders/post)",
  version: "0.0.1",
  type: "action",
  props: {
    allocadence,
    orderNumber: {
      type: "string",
      label: "Order Number",
      description: "Order number for the customer order.",
      optional: true,
    },
    clientId: {
      type: "integer",
      label: "Client Id",
      description: "Id of the client that the customer order is for.",
      optional: true,
    },
    clientName: {
      type: "string",
      label: "Client Name",
      description: "Name of the client that the customer order is for. **Ignored if clientId is provided and is nonzero.**",
      optional: true,
    },
    customerId: {
      type: "integer",
      label: "Customer Id",
      description: "Id of the customer. If none is provided, will attempt to find an existing customer based on the other customer fields and shipping address. Other fields not used if id is provided.",
      optional: true,
    },
    title: {
      type: "string",
      label: "Customer Title",
      description: "The title of the customer.",
      optional: true,
    },
    name: {
      type: "string",
      label: "Customer Name",
      description: "A combination of name and surname is required if the customer is new.",
      optional: true,
    },
    surname: {
      type: "string",
      label: "Customer Surname",
      description: "A combination of name and surname is required if the customer is new.",
      optional: true,
    },
    email: {
      type: "string",
      label: "Customer Email",
      description: "The email of the customer.",
      optional: true,
    },
    customerCompany: {
      type: "string",
      label: "Customer Company",
      description: "The company of the customer.",
      optional: true,
    },
    accountNumber: {
      type: "string",
      label: "Customer Account Number",
      description: "Will only match a customer on this field if provided.",
      optional: true,
    },
    shippingAddressId: {
      type: "integer",
      label: "Shipping Address Id",
      description: "Id of the shipping address. **Other Shipping fields will not be used if provided.**",
      optional: true,
    },
    shippingAddressCode: {
      type: "string",
      label: "Shipping Address Code",
      description: "Used to find an existing address. Other fields not used if an address is successfully found.",
      optional: true,
    },
    shippingAddressCompany: {
      type: "string",
      label: "Shipping Address Company",
      description: "The company of the shipping address.",
      optional: true,
    },
    shippingAddressName: {
      type: "string",
      label: "Shipping Address Name",
      description: "The name of the shipping address.",
      optional: true,
    },
    shippingAddressline1: {
      type: "string",
      label: "Shipping Address Line 1",
      description: "The shipping address line 1.",
      optional: true,
    },
    shippingAddressline2: {
      type: "string",
      label: "Shipping Address Line 2",
      description: "The shipping address line 2.",
      optional: true,
    },
    shippingAddressline3: {
      type: "string",
      label: "Shipping Address Line 3",
      description: "The shipping address line 3.",
      optional: true,
    },
    shippingAddressCity: {
      type: "string",
      label: "Shipping Address City",
      description: "The city of the shipping address.",
      optional: true,
    },
    shippingAddressState: {
      type: "string",
      label: "Shipping Address State",
      description: "The state of the shipping address.",
      optional: true,
    },
    shippingAddressZip: {
      type: "string",
      label: "Shipping Address Zip",
      description: "The zip of the shipping address.",
      optional: true,
    },
    shippingAddressCountryCode: {
      type: "string",
      label: "Shipping Address Country Code",
      description: "The country code of the shipping address. [See the ISO 3166 codes](https://www.iban.com/country-codes).",
      optional: true,
    },
    shippingAddressPhone: {
      type: "string",
      label: "Shipping Address Phone",
      description: "The phone of the shipping address.",
      optional: true,
    },
    sameAsShipping: {
      type: "boolean",
      label: "Same As Shipping",
      description: "True if the billing address is the same as the shipping address.",
      reloadProps: true,
      optional: true,
    },
    shipFromWarehouseId: {
      type: "string",
      label: "Ship From Warehouse Id",
      description: "Id of the warehouse the ordered items will be allocated from. If no warehouse parameters are given, then the user's current warehouse will be used.",
      optional: true,
    },
    shipFromWarehouseName: {
      type: "string",
      label: "Ship From Warehouse Name",
      description: "Name of the warehouse the ordered items will be allocated from. Ignored if warehouseId is provided.",
      optional: true,
    },
    shipVia: {
      type: "string",
      label: "Ship Via",
      description: "Code of the carrier or service to use for shipping.",
      optional: true,
    },
    postageAccount: {
      type: "string",
      label: "Postage Account",
      description: "Who to bill for shipping.",
      options: POSTAGE_ACCOUNT_OPTIONS,
      optional: true,
    },
    items: {
      type: "string[]",
      label: "Items",
      description: "An array of objects of ordered items. **Example: {\"itemId\": \"123\", \"sku\": \"SKU123\", \"quantity\": 1}** [See the documentation](https://docs.allocadence.com/#tag/customer_order/paths/~1customer-orders/post) fro further information.",
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};

    if (!this.sameAsShipping) {
      props.billingAddressId = {
        type: "integer",
        label: "Billing Address Id",
        description: "Id of the billing address. **Other Billing fields will not be used if provided.**",
        optional: true,
      };
      props.billingAddressCode = {
        type: "string",
        label: "Billing Address Code",
        description: "Used to find an existing address. Other fields not used if an address is successfully found.",
        optional: true,
      };
      props.billingAddressCompany = {
        type: "string",
        label: "Billing Address Company",
        description: "The company of the billing address.",
        optional: true,
      };
      props.billingAddressName = {
        type: "string",
        label: "Billing Address Name",
        description: "The name of the billing address.",
        optional: true,
      };
      props.billingAddressline1 = {
        type: "string",
        label: "Billing Address Line 1",
        description: "The billing address line 1.",
        optional: true,
      };
      props.billingAddressline2 = {
        type: "string",
        label: "Billing Address Line 2",
        description: "The billing address line 2.",
        optional: true,
      };
      props.billingAddressline3 = {
        type: "string",
        label: "Billing Address Line 3",
        description: "The billing address line 3.",
        optional: true,
      };
      props.billingAddressCity = {
        type: "string",
        label: "Billing Address City",
        description: "The city of the billing address.",
        optional: true,
      };
      props.billingAddressState = {
        type: "string",
        label: "Billing Address State",
        description: "The state of the billing address.",
        optional: true,
      };
      props.billingAddressZip = {
        type: "string",
        label: "Billing Address Zip",
        description: "The zip of the billing address.",
        optional: true,
      };
      props.billingAddressCountryCode = {
        type: "string",
        label: "Billing Address Country Code",
        description: "The country code of the billing address. [See the ISO 3166 codes](https://www.iban.com/country-codes).",
        optional: true,
      };
      props.billingAddressPhone = {
        type: "string",
        label: "Billing Address Phone",
        description: "The phone of the billing address.",
        optional: true,
      };
    }
    return props;
  },
  async run({ $ }) {
    if (!this.customerId &&
      !this.title &&
      !this.name &&
      !this.surname &&
      !this.email &&
      !this.customerCompany &&
      !this.accountNumber) {
      throw new ConfigurationError("You must provide at least 'Customer Id', 'Customer Title', 'Customer Name', 'Customer Surname', 'Customer Email', 'Customer Company' or 'Customer Account Number'.");
    }

    if (!this.shippingAddressId &&
      !this.shippingAddressline1 &&
      !this.shippingAddressCountryCode) {
      throw new ConfigurationError("You must provide at least 'Shipping Address Id' or 'Shipping Address Line1' and 'Shipping Address Country Code'.");
    }

    if (!this.sameAsShipping &&
      !this.billingAddressId &&
      !this.billingAddressline1 &&
      !this.billingAddressCountryCode) {
      throw new ConfigurationError("When 'Same As Shipping' is set **False** you must provide at least 'Billing Address Id' or 'Billing Address Line1' and 'Billing Address Country Code'.");
    }

    const response = await this.allocadence.createCustomerOrder({
      $,
      data: {
        orderNumber: this.orderNumber,
        clientId: this.clientId,
        clientName: this.clientName,
        customer: {
          id: this.customerId,
          title: this.title,
          name: this.name,
          surname: this.surname,
          email: this.email,
          company: this.customerCompany,
          accountNumber: this.accountNumber,
        },
        shippingAddress: {
          id: this.shippingAddressId,
          code: this.shippingAddressCode,
          company: this.shippingAddressCompany,
          name: this.shippingAddressName,
          line1: this.shippingAddressline1,
          line2: this.shippingAddressline2,
          line3: this.shippingAddressline3,
          city: this.shippingAddressCity,
          state: this.shippingAddressState,
          zip: this.shippingAddressZip,
          countryCode: this.shippingAddressCountryCode,
          phone: this.shippingAddressPhone,
        },
        billingAddress: {
          sameAsShipping: this.sameAsShipping,
          id: this.billingAddressId,
          code: this.billingAddressCode,
          company: this.billingAddressCompany,
          name: this.billingAddressName,
          line1: this.billingAddressline1,
          line2: this.billingAddressline2,
          line3: this.billingAddressline3,
          city: this.billingAddressCity,
          state: this.billingAddressState,
          zip: this.billingAddressZip,
          countryCode: this.billingAddressCountryCode,
          phone: this.billingAddressPhone,
        },
        shipFromWarehouseId: this.shipFromWarehouseId,
        shipFromWarehouseName: this.shipFromWarehouseName,
        shipVia: this.shipVia,
        postageAccount: this.postageAccount,
        items: parseObject(this.items),
      },
    });

    $.export("$summary", `Successfully created customer order with ID ${response.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
Allocadence	`allocadence`	`app`	This component uses the Allocadence app.
Order Number	`orderNumber`	`string`	Order number for the customer order.
Client Id	`clientId`	`integer`	Id of the client that the customer order is for.
Client Name	`clientName`	`string`	Name of the client that the customer order is for. Ignored if clientId is provided and is nonzero.
Customer Id	`customerId`	`integer`	Id of the customer. If none is provided, will attempt to find an existing customer based on the other customer fields and shipping address. Other fields not used if id is provided.
Customer Title	`title`	`string`	The title of the customer.
Customer Name	`name`	`string`	A combination of name and surname is required if the customer is new.
Customer Surname	`surname`	`string`	A combination of name and surname is required if the customer is new.
Customer Email	`email`	`string`	The email of the customer.
Customer Company	`customerCompany`	`string`	The company of the customer.
Customer Account Number	`accountNumber`	`string`	Will only match a customer on this field if provided.
Shipping Address Id	`shippingAddressId`	`integer`	Id of the shipping address. Other Shipping fields will not be used if provided.
Shipping Address Code	`shippingAddressCode`	`string`	Used to find an existing address. Other fields not used if an address is successfully found.
Shipping Address Company	`shippingAddressCompany`	`string`	The company of the shipping address.
Shipping Address Name	`shippingAddressName`	`string`	The name of the shipping address.
Shipping Address Line 1	`shippingAddressline1`	`string`	The shipping address line 1.
Shipping Address Line 2	`shippingAddressline2`	`string`	The shipping address line 2.
Shipping Address Line 3	`shippingAddressline3`	`string`	The shipping address line 3.
Shipping Address City	`shippingAddressCity`	`string`	The city of the shipping address.
Shipping Address State	`shippingAddressState`	`string`	The state of the shipping address.
Shipping Address Zip	`shippingAddressZip`	`string`	The zip of the shipping address.
Shipping Address Country Code	`shippingAddressCountryCode`	`string`	The country code of the shipping address. See the ISO 3166 codes.
Shipping Address Phone	`shippingAddressPhone`	`string`	The phone of the shipping address.
Same As Shipping	`sameAsShipping`	`boolean`	True if the billing address is the same as the shipping address.
Ship From Warehouse Id	`shipFromWarehouseId`	`string`	Id of the warehouse the ordered items will be allocated from. If no warehouse parameters are given, then the user's current warehouse will be used.
Ship From Warehouse Name	`shipFromWarehouseName`	`string`	Name of the warehouse the ordered items will be allocated from. Ignored if warehouseId is provided.
Ship Via	`shipVia`	`string`	Code of the carrier or service to use for shipping.
Postage Account	`postageAccount`	`string`	Select a value from the drop down menu:`senderclientrecipient`
Items	`items`	`string[]`	An array of objects of ordered items. Example: {"itemId": "123", "sku": "SKU123", "quantity": 1} See the documentation fro further information.