Create Comment with Airtable API on New Order Created from Square API

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

Trigger workflow on

New Order Created from the Square API

Next, do this

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

Select this integration
Configure the New Order Created trigger
1. Connect your Square account
2. Configure timer
3. Select a Location
Configure the Create Comment action
1. Connect your Airtable account
2. Select a Base
3. Select a Table
4. Select a Record ID
5. Configure Comment
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 Order Created on Square

Description:Emit new event for every new order created. [See the docs](https://developer.squareup.com/reference/square/orders-api/search-orders)

Version:0.0.3

Key:square-new-order-created

View on GitHub

Square Overview#

The Square API opens up a realm of possibilities for merchants to effortlessly manage their sales, inventory, customers, and payments. With Pipedream, you can automate actions based on events in Square, such as new transactions, updated orders, or customer profile changes. Craft custom workflows that react in real-time, sync data across platforms, or streamline reporting. Through Pipedream's serverless platform, you can connect Square with countless other apps without writing extensive code, turning manual tasks into automated, efficient processes.

Trigger Code#

import base from "../common/base-polling.mjs";
import constants from "../common/constants.mjs";

export default {
  ...base,
  key: "square-new-order-created",
  name: "New Order Created",
  description: "Emit new event for every new order created. [See the docs](https://developer.squareup.com/reference/square/orders-api/search-orders)",
  type: "source",
  version: "0.0.3",
  dedupe: "unique",
  props: {
    ...base.props,
    location: {
      propDefinition: [
        base.props.square,
        "location",
      ],
    },
  },
  hooks: {
    ...base.hooks,
    async deploy() {
      console.log(`Retrieving at most last ${constants.MAX_HISTORICAL_EVENTS} objects...`);
      const { order_entries: orders } = await this.square.listOrders({
        data: {
          ...this.getBaseParams(),
        },
      });
      if (!(orders?.length > 0)) {
        return;
      }
      this._setLastTs(Date.parse(orders[0].created_at));
      orders?.slice(0, constants.MAX_HISTORICAL_EVENTS)
        .reverse()
        .forEach((order) => this.$emit(order, this.generateMeta(order)));
    },
  },
  methods: {
    ...base.methods,
    getBaseParams() {
      return {
        limit: constants.MAX_LIMIT,
        location_ids: [
          this.location,
        ],
        query: {
          sort: {
            sort_field: "CREATED_AT",
            sort_order: "DESC",
          },
        },
      };
    },
    generateMeta(order) {
      return {
        id: order.id,
        summary: `Order created: ${order.id}`,
        ts: Date.parse(order.created_at),
      };
    },
  },
  async run() {
    const lastTs = this._getLastTs();
    let newLastTs;
    let cursor;
    let done = false;

    do {
      const response = await this.square.listOrders({
        data: {
          ...this.getBaseParams(),
          cursor,
        },
      });
      const { orders } = response;
      if (!(orders?.length > 0)) {
        break;
      }
      if (!newLastTs) {
        newLastTs = Date.parse(orders[0].created_at);
      }
      for (const order of orders) {
        if (Date.parse(order.created_at) <= lastTs) {
          done = true;
          break;
        }
        this.emitEvent(order);
      }
      cursor = response?.cursor;
    } while (cursor && !done);

    this._setLastTs(newLastTs);
  },
};

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
Square	`square`	`app`	This component uses the Square app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Location	`location`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Square uses OAuth authentication. When you connect your Square account, Pipedream will open a popup window where you can sign into Square and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Square API.

Pipedream requests the following authorization scopes when you connect your account:

CUSTOMERS_READCUSTOMERS_WRITEPAYMENTS_READPAYMENTS_WRITEORDERS_READORDERS_WRITESUBSCRIPTIONS_READSUBSCRIPTIONS_WRITEITEMS_READITEMS_WRITEINVOICES_READINVOICES_WRITELOYALTY_READLOYALTY_WRITEEMPLOYEES_READEMPLOYEES_WRITEMERCHANT_PROFILE_READBANK_ACCOUNTS_READSETTLEMENTS_READDEVELOPER_APPLICATION_WEBHOOKS_WRITEAPPOINTMENTS_ALL_READAPPOINTMENTS_READ

About Square#

Solutions & Tools to Grow Your Business

Action#

Create Comment on Airtable

Description:Create a new comment on a record. [See the documentation](https://airtable.com/developers/web/api/create-comment)

Version:0.0.6

Key:airtable_oauth-create-comment

View on GitHub

Airtable Overview#

Airtable (OAuth) API on Pipedream allows you to manipulate and leverage your Airtable data in a myriad of powerful ways. Sync data between Airtable and other apps, trigger workflows on updates, or process bulk data operations asynchronously. By using Airtable's structured databases with Pipedream's serverless platform, you can craft custom automation solutions, integrate with other services seamlessly, and streamline complex data processes.

Action Code#

import common from "../common/common.mjs";

export default {
  key: "airtable_oauth-create-comment",
  name: "Create Comment",
  description: "Create a new comment on a record. [See the documentation](https://airtable.com/developers/web/api/create-comment)",
  version: "0.0.6",
  type: "action",
  props: {
    ...common.props,
    recordId: {
      propDefinition: [
        common.props.airtable,
        "recordId",
        ({
          baseId, tableId,
        }) => ({
          baseId: baseId.value,
          tableId: tableId.value,
        }),
      ],
    },
    comment: {
      type: "string",
      label: "Comment",
      description: "The text comment",
    },
  },
  async run({ $ }) {
    const response = await this.airtable.createComment({
      baseId: this.baseId.value,
      tableId: this.tableId.value,
      recordId: this.recordId,
      data: {
        text: this.comment,
      },
      $,
    });

    if (response) {
      $.export("$summary", `Successfully created comment 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
Airtable	`airtable`	`app`	This component uses the Airtable app.
Base	`baseId`	`string`	Select a value from the drop down menu.
Table	`tableId`	`string`	Select a value from the drop down menu.
Record ID	`recordId`	`string`	Select a value from the drop down menu.
Comment	`comment`	`string`	The text comment

Action Authentication#

Airtable uses OAuth authentication. When you connect your Airtable account, Pipedream will open a popup window where you can sign into Airtable and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Airtable API.

Pipedream requests the following authorization scopes when you connect your account:

data.records:readdata.records:writedata.recordComments:readdata.recordComments:writeschema.bases:readschema.bases:writewebhook:manageuser.email:read

About Airtable#

Airtable is a low-code platform to build next-gen apps. Move beyond rigid tools, operationalize your critical data, and reimagine workflows with AI.

More Ways to Connect Airtable + Square#

Other Popular Integrations#

Create Comment with Airtable API on Custom Webhook Events from Square API

Square + Airtable

Create Comment with Airtable API on New Order Created from Square API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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