Create Customer with Shopify API on New Webhook Event (Instant) from Payhere API

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

Trigger workflow on

New Webhook Event (Instant) from the Payhere API

Next, do this

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

Select this integration
Configure the New Webhook Event (Instant) trigger
1. Connect your Payhere account
2. Configure Integration Name
3. Select a Event Type
Configure the Create Customer action
1. Connect your Shopify account
2. Optional- Configure First Name
3. Optional- Configure Last Name
4. Configure Email
5. Optional- Configure Phone Number
6. Optional- Configure Street Address
7. Optional- Configure Company
8. Optional- Configure City
9. Optional- Configure Province
10. Optional- Configure Country
11. Optional- Configure Zip Code
12. Optional- Configure Send Email Invite
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 Webhook Event (Instant) on Payhere

Description:Emit new event for each new webhook event

Version:0.0.1

Key:payhere-new-webhook-event

View on GitHub

Payhere Overview#

Payhere, powered by Xendit, offers a powerful API that allows you to craft seamless payment experiences within your apps and websites. By leveraging this API on Pipedream, you can automate payment processing, synchronize transaction data with accounting systems, or trigger communication based on payment events. Pipedream's serverless platform enables the orchestration of Payhere with an array of other services to streamline financial operations, enhance customer engagement, and maintain robust financial records.

Trigger Code#

import payhere from "../../payhere.app.mjs";
import constants from "../common/constants.mjs";

export default {
  key: "payhere-new-webhook-event",
  name: "New Webhook Event (Instant)",
  description: "Emit new event for each new webhook event",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  props: {
    payhere,
    db: "$.service.db",
    http: "$.interface.http",
    integrationName: {
      label: "Integration Name",
      description: "Friendly name of your platform, helps with metrics and debugging",
      type: "string",
    },
    resource: {
      label: "Event Type",
      description: "The event that will be listen",
      type: "string",
      options: constants.WEBHOOK_EVENT_TYPES,
    },
  },
  methods: {
    _getWebhookId() {
      return this.db.get("webhookId");
    },
    _setWebhookId(webhookId) {
      this.db.set("webhookId", webhookId);
    },
  },
  hooks: {
    async activate() {
      const response = await this.payhere.createWebhook({
        integration: this.integrationName,
        post_url: this.http.endpoint,
        resource: this.resource,
      });

      this._setWebhookId(response.id);
    },
    async deactivate() {
      const webhookId = this._getWebhookId();
      await this.payhere.removeWebhook(webhookId);
    },
  },
  async run(event) {
    const { body } = event;

    const resourceId = body?.payment?.id ?? body?.subscription?.id;
    const ts = body?.payment?.created_at ?? body?.subscription?.created_at;

    this.$emit(body, {
      id: resourceId,
      summary: `New event ${body.event} with id ${resourceId}`,
      ts: Date.parse(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
Payhere	`payhere`	`app`	This component uses the Payhere app.
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.
Integration Name	`integrationName`	`string`	Friendly name of your platform, helps with metrics and debugging
Event Type	`resource`	`string`	Select a value from the drop down menu:`{ "label": "Payment Received", "value": "payment_received" }{ "label": "Subscription Cancelled", "value": "subscription_cancelled" }{ "label": "Subscription Created", "value": "subscription_created" }`

Trigger Authentication#

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

You can find your API key in the integrations section of the merchants admin.

For environment, Payhere provides a sandbox site so you can easily test your integration without using your own money. See docs. If you aren't testing, use the production option.

About Payhere#

Easy payment links

Action#

Create Customer on Shopify

Description:Create a new customer. [See the documentation](https://shopify.dev/api/admin-rest/2022-01/resources/customer#[post]/admin/api/2022-01/customers.json)

Version:0.0.3

Key:shopify_developer_app-create-customer

View on GitHub

Shopify Overview#

The Shopify Admin REST & GraphQL API unleashes a myriad of possibilities to automate and enhance online store operations. It provides programmatic access to Shopify functionalities, allowing users to manage products, customers, orders, and more. Leveraging the Shopify Admin API within Pipedream, developers can create custom workflows that automate repetitive tasks, sync data across platforms, and respond dynamically to events in Shopify.

This integration can be used as a custom app on your store, or for automating actions on behalf of merchants through your Shopify app.

Looking for integrating into the Shopify Partner API for your apps, themes or referrals? Check out our Shopify Partner API integration.

Action Code#

import shopify from "../../shopify_developer_app.app.mjs";
import common from "../../../shopify/actions/create-customer/common.mjs";

export default {
  ...common,
  key: "shopify_developer_app-create-customer",
  name: "Create Customer",
  description: "Create a new customer. [See the documentation](https://shopify.dev/api/admin-rest/2022-01/resources/customer#[post]/admin/api/2022-01/customers.json)",
  version: "0.0.3",
  type: "action",
  props: {
    shopify,
    firstName: {
      propDefinition: [
        shopify,
        "firstName",
      ],
    },
    lastName: {
      propDefinition: [
        shopify,
        "lastName",
      ],
    },
    email: {
      propDefinition: [
        shopify,
        "email",
      ],
    },
    phone: {
      propDefinition: [
        shopify,
        "phone",
      ],
    },
    address: {
      propDefinition: [
        shopify,
        "address",
      ],
    },
    company: {
      propDefinition: [
        shopify,
        "company",
      ],
    },
    city: {
      propDefinition: [
        shopify,
        "city",
      ],
    },
    province: {
      propDefinition: [
        shopify,
        "province",
      ],
    },
    country: {
      propDefinition: [
        shopify,
        "country",
      ],
    },
    zip: {
      propDefinition: [
        shopify,
        "zip",
      ],
    },
    ...common.props,
  },
};

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
Shopify	`shopify`	`app`	This component uses the Shopify app.
First Name	`firstName`	`string`	The customer's first name
Last Name	`lastName`	`string`	The customer's last name
Email	`email`	`string`	The unique email address of the customer
Phone Number	`phone`	`string`	The unique phone number (E.164 format) for this customer. Check out Shopify Customer API for more details on valid formats
Street Address	`address`	`string`	The customer's mailing address
Company	`company`	`string`	The customer's company
City	`city`	`string`	The customer's city, town, or village
Province	`province`	`string`	The customer's region name. Typically a province, a state, or a prefecture
Country	`country`	`string`	The customer's country
Zip Code	`zip`	`string`	The customer's postal code
Send Email Invite	`sendEmailInvite`	`boolean`	Send email invite to address

Action Authentication#

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

Get your Access Token

Create a custom app in Shopify to obtain your Admin API access token. See our detailed instructions here.

Enter your Admin API access token below, and save it in a secure location (we recommend using a password manager such as 1Password)

Create Customer with Shopify API on New Webhook Event (Instant) from Payhere API

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

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

Developers ♥ Pipedream

Get your Access Token

1-24of2,400+apps by most popular

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