Create Customer with Square API on New Smart Contract Event (Instant) from Overledger API

Pipedream makes it easy to connect APIs for Square, Overledger and 3,000+ other apps remarkably fast.

Trigger workflow on

New Smart Contract Event (Instant) from the Overledger 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 Overledger 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 Smart Contract Event (Instant) trigger
1. Connect your Overledger account
2. Select a Overledger Instance
3. Select a Location Technology
4. Configure Smart Contract ID
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 Smart Contract Event (Instant) on Overledger

Description:Emit new event when a smart contract releases a new event.

Version:0.0.3

Key:overledger-new-contract-event-instant

View on GitHub

Overledger Overview#

The Overledger API by Quant Network allows developers to interact with multiple blockchain networks. It facilitates the creation, reading, and execution of smart contracts and transactions across different blockchains. This API simplifies the complex nature of blockchain interoperability, enabling multi-chain applications (MApps) through a single gateway.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "overledger-new-contract-event-instant",
  name: "New Smart Contract Event (Instant)",
  description: "Emit new event when a smart contract releases a new event.",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    smartContractId: {
      propDefinition: [
        common.props.overledger,
        "smartContractId",
      ],
    },
  },
  methods: {
    getPath() {
      return "smart-contract-events";
    },
    additionalData() {
      return {
        smartContractId: this.smartContractId,
      };
    },
    getSummary(body) {
      return `New contract event with transaction Hash: ${body?.smartContractEventUpdateDetails?.nativeData?.transactionHash}`;
    },
  },
  sampleEmit,
};

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
Overledger	`overledger`	`app`	This component uses the Overledger app.
Overledger Instance	`environment`	`string`	Select a value from the drop down menu:`{ "label": "Sandbox", "value": "sandbox" }{ "label": "Overledger", "value": "overledger" }`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Location Technology	`locationTechnology`	`string`	Select a value from the drop down menu:`{ "label": "Ethereum", "value": "ethereum" }{ "label": "Substrate", "value": "substrate" }{ "label": "XRP Ledger", "value": "xrp ledger" }{ "label": "Bitcoin", "value": "bitcoin" }{ "label": "Hyperledger Fabric", "value": "hyperledger fabric" }`
Smart Contract ID	`smartContractId`	`string`	The ID of the smart contract to interact with.

Trigger Authentication#

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

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

overledger/read.scope

About Overledger#

Overledger Platform. The enterprise standard for building on blockchain.

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.4

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.4",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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 Smart Contract Event (Instant) from Overledger API

Pipedream makes it easy to connect APIs for Square, Overledger and 3,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of3,000+apps by most popular

1
-
24
of
3,000+
apps by most popular