Create Customer with Square API on New Events (Instant) from Twilio SendGrid API

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

Trigger workflow on

New Events (Instant) from the Twilio SendGrid 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 Twilio SendGrid 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 Events (Instant) trigger
1. Connect your Twilio SendGrid account
2. Select one or more Event Types
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 Events (Instant) on Twilio SendGrid

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

Version:0.0.5

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.5",
  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 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

Create Customer with Square API on New Events (Instant) from Twilio SendGrid API

Pipedream makes it easy to connect APIs for Square, Twilio SendGrid 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