Create a New Charge with OPN (formerly Omise) API on New Contact from Twilio SendGrid API

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

Trigger workflow on

New Contact from the Twilio SendGrid API

Next, do this

Create a New Charge with the OPN (formerly Omise) 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 OPN (formerly Omise) action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Contact trigger
1. Connect your Twilio SendGrid account
2. Configure timer
Configure the Create a New Charge action
1. Connect your OPN (formerly Omise) account
2. Configure Amount
3. Select a Currency
4. Optional- Select a Authorization Type
5. Optional- Configure Capture
6. Optional- Select a Customer ID
7. Optional- Select a Card
8. Optional- Configure Description
9. Optional- Configure Expires At
10. Optional- Configure IP
11. Optional- Configure Metadata
12. Optional- Configure Platform Fee
13. Optional- Configure Return URI
14. Optional- Configure Source ID
15. Optional- Configure Webhook Endpoints
16. Optional- Configure Zero Interest Installments
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 Contact on Twilio SendGrid

Description:Emit new event when a new contact is created

Version:0.0.6

Key:sendgrid-new-contact

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 orderBy from "lodash/orderBy.js";
import common from "../common/timer-based.mjs";

export default {
  ...common,
  key: "sendgrid-new-contact",
  name: "New Contact",
  description: "Emit new event when a new contact is created",
  version: "0.0.6",
  type: "source",
  dedupe: "unique",
  hooks: {
    async activate() {
      const currentTimestamp = Date.now();
      const state = {
        processedItems: [],
        lowerTimestamp: currentTimestamp,
        upperTimestamp: currentTimestamp,
      };
      this.db.set("state", state);
    },
  },
  methods: {
    ...common.methods,
    _maxDelayTime() {
      // There is no report from SendGrid as to how much time it takes
      // for a contact to be created and appear in search results, so
      // we're using a rough estimate of 30 minutes here.
      return 30 * 60 * 1000;  // 30 minutes, in milliseconds
    },
    _addDelayOffset(timestamp) {
      return timestamp - this._maxDelayTime();
    },
    _cleanupOldProcessedItems(processedItems, currentTimestamp) {
      return processedItems
        .map((item) => ({
          // We just need to keep track of the record ID and
          // its creation date.
          id: item.id,
          created_at: item.created_at,
        }))
        .filter((item) => {
          const { created_at: createdAt } = item;
          const createdAtTimestamp = Date.parse(createdAt);
          const cutoffTimestamp = this._addDelayOffset(currentTimestamp);
          return createdAtTimestamp > cutoffTimestamp;
        });
    },
    _makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp) {
      const idList = processedItems
        .map((item) => item.id)
        .map((id) => `'${id}'`)
        .join(", ")
      || "''";
      const startTimestamp = this._addDelayOffset(lowerTimestamp);
      const startDate = this.toISOString(startTimestamp);
      const endDate = this.toISOString(upperTimestamp);
      return `
        contact_id NOT IN (${idList}) AND
        created_at BETWEEN
          TIMESTAMP '${startDate}' AND
          TIMESTAMP '${endDate}'
      `;
    },
    generateMeta(data) {
      const {
        item,
        eventTimestamp: ts,
      } = data;
      const {
        id,
        email,
      } = item;
      const slugifiedEmail = this.slugifyEmail(email);
      const summary = `New contact: ${slugifiedEmail}`;
      return {
        id,
        summary,
        ts,
      };
    },
    async processEvent(event) {
      // Transform the timer timestamp to milliseconds
      // to be consistent with how Javascript handles timestamps.
      const eventTimestamp = event.timestamp * 1000;

      // Retrieve the current state of the component.
      const {
        processedItems,
        lowerTimestamp,
        upperTimestamp,
      } = this.db.get("state");

      // Search for contacts within a specific timeframe, excluding
      // items that have already been processed.
      const query = this._makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp);
      const {
        result: items,
        contact_count: contactCount,
      } = await this.sendgrid.searchContacts(query);

      // If no contacts have been retrieved via the API,
      // move the time window forward to possibly capture newer contacts.
      if (contactCount === 0) {
        const newState = {
          processedItems: this._cleanupOldProcessedItems(processedItems, lowerTimestamp),
          lowerTimestamp: upperTimestamp,
          upperTimestamp: eventTimestamp,
        };
        this.db.set("state", newState);
        return;
      }

      // We process the searched records from oldest to newest.
      const itemsToProcess = orderBy(items, "created_at");
      itemsToProcess
        .forEach((item) => {
          const meta = this.generateMeta({
            item,
            eventTimestamp,
          });
          this.$emit(item, meta);
        });

      // Use the timestamp of the last processed record as a lower bound for
      // following searches. This bound will be subjected to an offset so in
      // case older records appear in future search results, but have not
      // appeared until now, can be processed. We only adjust it if it means
      // moving forward, not backwards. Otherwise, we might start retrieving
      // older and older records indefinitely (and we're all about *new*
      // records!)
      const newLowerTimestamp = Math.max(
        lowerTimestamp,
        Date.parse(itemsToProcess[0].created_at),
      );

      // If the total contact count is less than 100, it means that during the
      // next iteration the search results count will most likely be less than
      // 50. In that case, if we extend the upper bound of the search time range
      // we might be able to retrieve more records.
      const newUpperTimestamp = contactCount < 100
        ? eventTimestamp
        : upperTimestamp;

      // The list of processed items can grow indefinitely.
      // Since we don't want to keep track of every processed record
      // ever, we need to clean up this list, removing any records
      // that are no longer relevant.
      const newProcessedItems = this._cleanupOldProcessedItems(
        [
          ...processedItems,
          ...itemsToProcess,
        ],
        newLowerTimestamp,
      );

      // Update the state of the component to reflect the computations
      // made above.
      const newState = {
        processedItems: newProcessedItems,
        lowerTimestamp: newLowerTimestamp,
        upperTimestamp: newUpperTimestamp,
      };
      this.db.set("state", newState);
    },
  },
};

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.
	`timer`	`$.interface.timer`

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 a New Charge on OPN (formerly Omise)

Description:Create a new charge for a specific customer and amount through the OPN platform. [See the documentation](https://docs.opn.ooo/charges-api#create)

Version:0.0.1

Key:omise-create-charge

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.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import { parseObject } from "../../common/utils.mjs";
import omiseApp from "../../omise.app.mjs";

export default {
  key: "omise-create-charge",
  name: "Create a New Charge",
  description: "Create a new charge for a specific customer and amount through the OPN platform. [See the documentation](https://docs.opn.ooo/charges-api#create)",
  version: "0.0.1",
  type: "action",
  props: {
    omiseApp,
    amount: {
      propDefinition: [
        omiseApp,
        "amount",
      ],
    },
    currency: {
      propDefinition: [
        omiseApp,
        "currency",
      ],
    },
    authorizationType: {
      type: "string",
      label: "Authorization Type",
      description: "The type of the authorization for the charge.",
      options: [
        "pre_auth",
        "final_auth",
      ],
      optional: true,
    },
    capture: {
      propDefinition: [
        omiseApp,
        "capture",
      ],
      optional: true,
    },
    customer: {
      propDefinition: [
        omiseApp,
        "customerId",
      ],
      optional: true,
    },
    card: {
      propDefinition: [
        omiseApp,
        "card",
        ({ customer }) => ({
          customer,
        }),
      ],
      description: "An unused token identifier to add as a new card to the charge.",
      optional: true,
    },
    description: {
      propDefinition: [
        omiseApp,
        "description",
      ],
      description: "Charge description. Supplying information about a purchase (e.g. number of items, type of items, date of delivery) helps Opn Payments better conduct fraud analysis.",
      optional: true,
    },
    expiresAt: {
      type: "string",
      label: "Expires At",
      description: "UTC datetime of desired charge expiration in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format `(YYYY-MM-DDThh:mm:ssZ)`.",
      optional: true,
    },
    ip: {
      type: "string",
      label: "IP",
      description: "IP address to attach to the charge. Supplying the customer's real IP address helps Opn Payments better conduct fraud analysis. May be IPv4 or IPv6.",
      optional: true,
    },
    metadata: {
      propDefinition: [
        omiseApp,
        "metadata",
      ],
      description: "Custom metadata (e.g. `{\"answer\": 42}`) for charge.",
      optional: true,
    },
    platformFee: {
      type: "object",
      label: "Platform Fee",
      description: "Platform fee object as `fixed` amount and/or `percentage` of charge amount.",
      optional: true,
    },
    returnUri: {
      propDefinition: [
        omiseApp,
        "returnUri",
      ],
      optional: true,
    },
    source: {
      propDefinition: [
        omiseApp,
        "sourceId",
      ],
      optional: true,
    },
    webhookEndpoints: {
      type: "string[]",
      label: "Webhook Endpoints",
      description: "URLs to which charge notifications are to be sent. This field can contain a maximum of two URLs.",
      optional: true,
    },
    zeroInterestInstallments: {
      type: "boolean",
      label: "Zero Interest Installments",
      description: "Whether merchant absorbs the interest for installment payments; must match value in associated source.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.card && !this.customer && !this.source) {
      throw new ConfigurationError("`Source` is required if `card` and `customer` are not present.");
    }
    const {
      omiseApp,
      authorizationType,
      expiresAt,
      platformFee,
      returnUri,
      webhookEndpoints,
      zeroInterestInstallments,
      ...data
    } = this;
    const response = await omiseApp.createCharge({
      $,
      data: {
        ...data,
        authorization_type: authorizationType,
        expires_at: expiresAt,
        platform_fee: parseObject(platformFee),
        return_uri: returnUri,
        webhook_endpoints: parseObject(webhookEndpoints),
        zero_interest_installments: zeroInterestInstallments,
      },
    });

    $.export("$summary", `Successfully created a new charge with ID: ${response.id}`);
    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
OPN (formerly Omise)	`omiseApp`	`app`	This component uses the OPN (formerly Omise) app.
Amount	`amount`	`integer`	The amount for the charge in the smallest currency unit.
Currency	`currency`	`string`	Select a value from the drop down menu:`{ "label": "Japan", "value": "JPY" }{ "label": "Malaysia", "value": "MYR" }{ "label": "Singapore", "value": "SGD" }{ "label": "Thailand", "value": "THB" }`
Authorization Type	`authorizationType`	`string`	Select a value from the drop down menu:`pre_authfinal_auth`
Capture	`capture`	`boolean`	Whether the charge is set to be automatically captured (paid). Valid only for credit and debit card charges.
Customer ID	`customer`	`string`	Select a value from the drop down menu.
Card	`card`	`string`	Select a value from the drop down menu.
Description	`description`	`string`	Charge description. Supplying information about a purchase (e.g. number of items, type of items, date of delivery) helps Opn Payments better conduct fraud analysis.
Expires At	`expiresAt`	`string`	UTC datetime of desired charge expiration in ISO 8601 format `(YYYY-MM-DDThh:mm:ssZ)`.
IP	`ip`	`string`	IP address to attach to the charge. Supplying the customer's real IP address helps Opn Payments better conduct fraud analysis. May be IPv4 or IPv6.
Metadata	`metadata`	`object`	Custom metadata (e.g. `{"answer": 42}`) for charge.
Platform Fee	`platformFee`	`object`	Platform fee object as `fixed` amount and/or `percentage` of charge amount.
Return URI	`returnUri`	`string`	The URI to which the customer is redirected after authorization. Required if `card` and `customer` are not present.
Source ID	`source`	`string`	A valid source identifier or source object
Webhook Endpoints	`webhookEndpoints`	`string[]`	URLs to which charge notifications are to be sent. This field can contain a maximum of two URLs.
Zero Interest Installments	`zeroInterestInstallments`	`boolean`	Whether merchant absorbs the interest for installment payments; must match value in associated source.

Action 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,