Create Customer with Square API on New SMS Message Received from Bird API

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

Trigger workflow on

New SMS Message Received from the Bird API

Next, do this

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

Select this integration
Configure the New SMS Message Received trigger
1. Connect your Bird account
2. Configure timer
Configure the Create Customer action
1. Connect your Square account
2. Optional- Configure Given Name
3. Optional- Configure Family Name
4. Optional- Configure Company Name
5. Optional- Configure Email Address
6. Optional- Configure Phone Number
7. Optional- Configure Reference ID
8. Optional- Configure Note
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 SMS Message Received on Bird

Description:Emit new event when a new SMS message is received. [See the documentation](https://developers.messagebird.com/api/sms-messaging/#list-messages)

Version:0.0.1

Key:message_bird-new-sms-message-received

View on GitHub

Bird Overview#

Message Bird is a communications platform offering a suite of API solutions for sending messages, making voice calls, and conducting video conferences. With Pipedream, you can harness these capabilities to automate personalized notifications, streamline customer support, and facilitate global communication workflows. Message Bird's API on Pipedream allows you to send real-time alerts, trigger voice messages based on customer actions, and integrate with other services to create powerful, multi-channel communication systems.

Trigger Code#

import messagebird from "../../message_bird.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "message_bird-new-sms-message-received",
  name: "New SMS Message Received",
  description: "Emit new event when a new SMS message is received. [See the documentation](https://developers.messagebird.com/api/sms-messaging/#list-messages)",
  version: "0.0.1",
  dedupe: "unique",
  type: "source",
  props: {
    messagebird,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  methods: {
    _getLastTs() {
      return this.db.get("lastTs");
    },
    _setLastTs(lastTs) {
      this.db.set("lastTs", lastTs);
    },
    generateMeta(message) {
      return {
        id: message.id,
        summary: `New Message ID: ${message.id}`,
        ts: Date.parse(message.createdDatetime),
      };
    },
  },
  async run() {
    let lastTs = this._getLastTs();

    const { items } = await this.messagebird.listSMSMessages({
      params: {
        direction: "mo", // mt = sent, mo = received
        type: "sms",
        from: lastTs,
      },
    });

    if (!items?.length) {
      return;
    }

    for (const message of items) {
      const meta = this.generateMeta(message);
      this.$emit(message, meta);

      if (!lastTs || Date.parse(message.createdDatetime) > Date.parse(lastTs)) {
        lastTs = message.createdDatetime;
      }
    }

    this._setLastTs(lastTs);
  },
};

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
Bird	`messagebird`	`app`	This component uses the Bird app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

Once you sign in, the API key information are available in the Developer Settings, which is shown as Manage API Keys in the middle right of the Dashboard

About Bird#

Business in a box. Grow, Manage, Automate your company. Everything you need in one app.

Action#

Create Customer on Square

Description:Creates a new customer for a business. Must provide at least one of the following: Given Name, Family Name, Company Name, Email Address, or Phone Number. [See the docs](https://developer.squareup.com/reference/square/customers-api/create-customer).

Version:0.0.3

Key:square-create-customer

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.

Action Code#

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

export default {
  key: "square-create-customer",
  name: "Create Customer",
  description: `Creates a new customer for a business. Must provide at least one of the following:
    Given Name, Family Name, Company Name, Email Address, or Phone Number. [See the docs](https://developer.squareup.com/reference/square/customers-api/create-customer).`,
  type: "action",
  version: "0.0.3",
  props: {
    square,
    givenName: {
      type: "string",
      label: "Given Name",
      description: "The first name associated with the customer profile",
      optional: true,
    },
    familyName: {
      type: "string",
      label: "Family Name",
      description: "The last name associated with the customer profile",
      optional: true,
    },
    companyName: {
      type: "string",
      label: "Company Name",
      description: "A business name associated with the customer profile",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email Address",
      description: "The email address associated with the customer profile",
      optional: true,
    },
    phoneNumber: {
      type: "string",
      label: "Phone Number",
      description: "Must be a valid phone number and can contain 9-16 digits, with an optional + prefix and country code",
      optional: true,
    },
    referenceId: {
      propDefinition: [
        square,
        "referenceId",
      ],
    },
    note: {
      type: "string",
      label: "Note",
      description: "A custom note associated with the customer profile",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.square.createCustomer({
      $,
      generateIdempotencyKey: true,
      data: {
        given_name: this.givenName,
        family_name: this.familyName,
        company_name: this.companyName,
        email_address: this.email,
        phone_number: this.phoneNumber,
        reference_id: this.referenceId,
        note: this.note,
      },
    });
    $.export("$summary", "Successfully created customer");
    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
Square	`square`	`app`	This component uses the Square app.
Given Name	`givenName`	`string`	The first name associated with the customer profile
Family Name	`familyName`	`string`	The last name associated with the customer profile
Company Name	`companyName`	`string`	A business name associated with the customer profile
Email Address	`email`	`string`	The email address associated with the customer profile
Phone Number	`phoneNumber`	`string`	Must be a valid phone number and can contain 9-16 digits, with an optional + prefix and country code
Reference ID	`referenceId`	`string`	An optional second ID used to associate the customer profile with an entity in another system
Note	`note`	`string`	A custom note associated with the customer profile

Action 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

More Ways to Connect Square + Bird#

Other Popular Integrations#

Create Order with Square API on New SMS Message Received from Bird API

Bird + Square

Create Customer with Square API on New SMS Message Received from Bird API

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

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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