Create User Invite with Waitwhile API on Catalog Item Updated from Square API

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

Trigger workflow on

Catalog Item Updated from the Square API

Next, do this

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

Select this integration
Configure the Catalog Item Updated trigger
1. Connect your Square account
2. Configure timer
Configure the Create User Invite action
1. Connect your Waitwhile account
2. Configure Name
3. Configure Email
4. Optional- Configure Phone
5. Optional- Configure Default Location ID
6. Optional- Select one or more Location IDs
7. Optional- Configure Roles
8. Optional- Select a Resource 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#

Catalog Item Updated on Square

Description:Emit new event every time a catalog item is updated. [See the docs](https://developer.squareup.com/reference/square/catalog-api/list-catalog)

Version:0.0.3

Key:square-catalog-item-updated

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-catalog-item-updated",
  name: "Catalog Item Updated",
  description: "Emit new event every time a catalog item is updated. [See the docs](https://developer.squareup.com/reference/square/catalog-api/list-catalog)",
  type: "source",
  version: "0.0.3",
  dedupe: "unique",
  hooks: {
    ...base.hooks,
    async deploy() {
      console.log(`Retrieving at most last ${constants.MAX_HISTORICAL_EVENTS} objects...`);
      const { objects } = await this.square.listCatalogItems({
        params: {
          ...this.getBaseParams(),
        },
      });
      if (!(objects?.length > 0)) {
        return;
      }

      let newLastTs = 0;
      for (const object of objects.slice(0, constants.MAX_HISTORICAL_EVENTS)) {
        if (Date.parse(object.updated_at) > newLastTs) {
          newLastTs = Date.parse(object.updated_at);
        }
        this.$emit(object, this.generateMeta(object));
      }
      this._setLastTs(newLastTs);
    },
  },
  methods: {
    ...base.methods,
    getBaseParams() {
      return {
        limit: constants.MAX_LIMIT,
        types: "ITEM",
      };
    },
    generateMeta(object) {
      const ts = Date.parse(object.updated_at);
      return {
        id: `${object.id}${ts}`,
        summary: `Catalog Item Updated: ${object.id}`,
        ts,
      };
    },
  },
  async run() {
    const lastTs = this._getLastTs();
    let newLastTs = lastTs;
    let cursor;

    do {
      const response = await this.square.listCatalogItems({
        params: {
          ...this.getBaseParams(),
          cursor,
        },
      });
      const { objects } = response;
      if (!(objects?.length > 0)) {
        break;
      }
      for (const object of objects) {
        if (Date.parse(object.updated_at) > lastTs) {
          newLastTs = Date.parse(object.updated_at);
        }
        this.emitEvent(object);
      }
      cursor = response?.cursor;
    } while (cursor);

    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`

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 User Invite on Waitwhile

Description:Create a user invite. [See the doc here](https://developers.waitwhile.com/reference/postinvites)

Version:0.0.1

Key:waitwhile-create-user-invite

View on GitHub

Waitwhile Overview#

Waitwhile is a queue management and scheduling platform that lets you optimize appointments and waitlists, enhancing the customer experience. By leveraging the Waitwhile API on Pipedream, you can automate processes such as updating waitlists, syncing customer data, or triggering notifications when a customer's status changes. This seamless integration can streamline operations for businesses like restaurants, healthcare providers, or service centers where queue management is crucial.

Action Code#

import waitwhile from "../../app/waitwhile.app.mjs";
import { defineAction } from "@pipedream/types";
export default defineAction({
    name: "Create User Invite",
    version: "0.0.1",
    key: "waitwhile-create-user-invite",
    description: "Create a user invite. [See the doc here](https://developers.waitwhile.com/reference/postinvites)",
    props: {
        waitwhile,
        name: {
            propDefinition: [
                waitwhile,
                "name",
            ],
        },
        email: {
            propDefinition: [
                waitwhile,
                "email",
            ],
        },
        phone: {
            propDefinition: [
                waitwhile,
                "phone",
            ],
        },
        defaultLocationId: {
            label: "Default Location ID",
            type: "string",
            optional: true,
            description: "Identifier of location",
        },
        locationIds: {
            label: "Location IDs",
            type: "string[]",
            description: "Identifier of customer, automatically derived from visitor contact information if not provided.",
            optional: true,
            propDefinition: [
                waitwhile,
                "locationId",
            ],
        },
        roles: {
            label: "Roles",
            type: "string[]",
            optional: true,
            description: "User roles",
        },
        resourceId: {
            propDefinition: [
                waitwhile,
                "resourceId",
            ],
        },
    },
    type: "action",
    methods: {},
    async run({ $ }) {
        const params = {
            name: this.name,
            email: this.email,
            phone: this.phone,
            defaultLocationId: this.defaultLocationId,
            locationIds: this.locationIds,
            roles: this.roles,
            resourceId: this.resourceId,
        };
        try {
            const data = await this.waitwhile.createUserInvite(params);
            $.export("summary", `Successfully created a user invite with ID: ${data.id}`);
            return data;
        }
        catch (error) {
            const statusCode = error[Object.getOwnPropertySymbols(error)[1]].status;
            const statusText = error[Object.getOwnPropertySymbols(error)[1]].statusText;
            throw new Error(`Error status code: ${statusCode}. Error status response: ${statusText}`);
        }
    },
});

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
Waitwhile	`waitwhile`	`app`	This component uses the Waitwhile app.
Name	`name`	`string`	Name
Email	`email`	`string`	Email address
Phone	`phone`	`string`	Phone number in E.164 format
Default Location ID	`defaultLocationId`	`string`	Identifier of location
Location IDs	`locationIds`	`string[]`	Select a value from the drop down menu.
Roles	`roles`	`string[]`	User roles
Resource ID	`resourceId`	`string`	Select a value from the drop down menu.

Action Authentication#

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

To retrieve your API keys,

Navigate to your Waitwhile account and sign in
Go to “Settings” > “API & Webhooks”

About Waitwhile#

Waitwhile is a virtual waitlist app and queue management platform that can be customized to work for any business.

More Ways to Connect Waitwhile + Square#

Other Popular Integrations#

Add Customer Note Entry with Waitwhile API on Catalog Item Updated from Square API

Square + Waitwhile

Create User Invite with Waitwhile API on Catalog Item Updated from Square API

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

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

Developers ♥ Pipedream

1-24of2,800+apps by most popular

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