Create Appointment with Setmore API on New Payment Received from OPN (formerly Omise) API

Pipedream makes it easy to connect APIs for Setmore, OPN (formerly Omise) and 2,000+ other apps remarkably fast.

Trigger workflow on

New Payment Received from the OPN (formerly Omise) API

Next, do this

Create Appointment with the Setmore API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a OPN (formerly Omise) trigger and Setmore action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Payment Received trigger
1. Connect your OPN (formerly Omise) account
2. Configure timer
Configure the Create Appointment action
1. Connect your Setmore account
2. Select a Staff
3. Select a Service
4. Configure Customer Email
5. Configure Start Time
6. Configure End Time
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 Payment Received on OPN (formerly Omise)

Description:Emit new event for each payment received through the OPN platform.

Version:0.0.1

Key:omise-payment-received

View on GitHub

OPN (formerly Omise) Overview#

The OPN API, previously known as Omise, provides a powerful suite of features for handling online payments, from processing transactions to managing payment methods. With Pipedream's integration capabilities, you can automate various aspects of payment operations, link payment events to other services, and streamline financial workflows without the need for extensive coding.

Trigger Code#

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

export default {
  ...common,
  key: "omise-payment-received",
  name: "New Payment Received",
  description: "Emit new event for each payment received through the OPN platform.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getFilter() {
      return "paid_at";
    },
    getSummary(item) {
      return `Payment Received: ${item.amount} ${item.currency}`;
    },
  },
  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
OPN (formerly Omise)	`omiseApp`	`app`	This component uses the OPN (formerly Omise) app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

To retrieve your API keys,

Navigate to your OPN (formerly Omise) account and sign in
Go to “API” > “Keys”

About OPN (formerly Omise)#

Action#

Create Appointment on Setmore

Description:Create a new appointment in Setmore Appointments. [See the documentation](https://setmore.docs.apiary.io/#introduction/appointments/create-an-appointment)

Version:0.0.1

Key:setmoreappointments-create-appointment

View on GitHub

Setmore Overview#

The Setmore API opens doors to automating appointment scheduling and calendar management, allowing you to sync appointments, customer information, and services across different platforms. This seamless integration through Pipedream can trigger workflows from new appointments, update external CRMs with customer data, or prep team communication channels with upcoming schedule details. By harnessing the Setmore API on Pipedream, you're equipping yourself to orchestrate complex operations with simplicity and precision.

Action Code#

import setmore from "../../setmoreappointments.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "setmoreappointments-create-appointment",
  name: "Create Appointment",
  description: "Create a new appointment in Setmore Appointments. [See the documentation](https://setmore.docs.apiary.io/#introduction/appointments/create-an-appointment)",
  version: "0.0.1",
  type: "action",
  props: {
    setmore,
    staffKey: {
      propDefinition: [
        setmore,
        "staffKey",
      ],
    },
    serviceKey: {
      propDefinition: [
        setmore,
        "serviceKey",
      ],
    },
    customerEmail: {
      type: "string",
      label: "Customer Email",
      description: "Email address of the customer",
    },
    startTime: {
      type: "string",
      label: "Start Time",
      description: "Appointment start time. Format `yyyy-MM-ddTHH:mm`",
    },
    endTime: {
      type: "string",
      label: "End Time",
      description: "Appointment end time. Format `yyyy-MM-ddTHH:mm`",
    },
  },
  async run({ $ }) {
    const { data: { customer } } = await this.setmore.getCustomer({
      params: {
        email: this.customerEmail,
      },
    });
    if (!customer?.length) {
      throw new ConfigurationError(`Customer with email ${this.customerEmail} not found.`);
    }
    const customerKey = customer[0].key;

    const {
      data, msg,
    } = await this.setmore.createAppointment({
      data: {
        staff_key: this.staffKey,
        service_key: this.serviceKey,
        customer_key: customerKey,
        start_time: this.startTime,
        end_time: this.endTime,
      },
      $,
    });

    if (data) {
      $.export("$summary", `Successfully created appointment with key ${data.appointment.key}.`);
    } else {
      throw new Error(`${msg}`);
    }

    return data.appointment;
  },
};

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
Setmore	`setmore`	`app`	This component uses the Setmore app.
Staff	`staffKey`	`string`	Select a value from the drop down menu.
Service	`serviceKey`	`string`	Select a value from the drop down menu.
Customer Email	`customerEmail`	`string`	Email address of the customer
Start Time	`startTime`	`string`	Appointment start time. Format `yyyy-MM-ddTHH:mm`
End Time	`endTime`	`string`	Appointment end time. Format `yyyy-MM-ddTHH:mm`

Action Authentication#

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

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