Create Payment Reference with ifthenpay API on Webhook Destination (Instant) from Segment API

Pipedream makes it easy to connect APIs for ifthenpay, Segment and 2,700+ other apps remarkably fast.

Trigger workflow on

Webhook Destination (Instant) from the Segment API

Next, do this

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

Select this integration
Configure the Webhook Destination (Instant) trigger
1. Connect your Segment account
2. Select a Workspace
3. Select a Source
4. Configure Name
5. Optional- Configure Trigger
Configure the Create Payment Reference action
1. Connect your ifthenpay account
2. Select a Payment Method
3. Configure Mb Key
4. Configure Mb Way Key
5. Configure Order Id
6. Configure Amount
7. Configure Mobile Number
8. Optional- Configure Description
9. Optional- Configure URL
10. Optional- Configure Client Code
11. Optional- Configure Client Name
12. Optional- Configure Email
13. Optional- Configure Client Username
14. Optional- Configure Client Phone
15. Optional- Configure Expiry Days
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#

Webhook Destination (Instant) on Segment

Description:Send events to a webhook. Requires a Team or Business account.

Version:0.0.2

Key:segment-webhook-destination

View on GitHub

Segment Overview#

The Segment API enables you to collect, manage, and route your customer analytics data to various tools for marketing, analytics, and data warehousing. By harnessing the Segment API on Pipedream, you can automate the ingestion and syncing of user events and properties to multiple destinations, allowing you to create seamless data pipelines without manual intervention. Pipedream's serverless platform empowers you to build custom workflows that react to events in real-time, enrich data, or trigger actions across your tech stack.

Trigger Code#

import segmentApp from "../../segment.app.mjs";

export default {
  key: "segment-webhook-destination",
  name: "Webhook Destination (Instant)",
  description: "Send events to a webhook. Requires a Team or Business account.",
  version: "0.0.2",
  type: "source",
  props: {
    segmentApp,
    db: "$.service.db",
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    workspace: {
      propDefinition: [
        segmentApp,
        "workspace",
      ],
    },
    source: {
      propDefinition: [
        segmentApp,
        "source",
        ({ workspace }) => ({
          workspace,
        }),
      ],
    },
    name: {
      type: "string",
      label: "Name",
      description: "Defines the display name of the Destination",
    },
    trigger: {
      type: "string",
      label: "Trigger",
      description: "Destination FQL Statement. [Filter Query Language](https://segment.com/docs/api/public-api/fql/)",
      optional: true,
      default: "type = \"identify\" or type = \"track\" or type = \"group\"",
    },
  },
  hooks: {
    async activate() {
      const { data } = await this.segmentApp.createDestination({
        data: {
          sourceId: this.source,
          metadataId: await this.findMetadataId(),
          name: this.name,
          enabled: true,
          connection_mode: "UNSPECIFIED",
          settings: {},
        },
      });
      const destinationId = data.destination.id;
      this.setDestinationId(destinationId);

      const response = await this.segmentApp.createDestinationSubscription({
        destination: destinationId,
        data: {
          name: "Pipedream Webhook Subscription",
          trigger: this.trigger,
          actionId: await this.findActionId(destinationId),
          enabled: true,
          settings: {
            method: "POST",
            url: this.http.endpoint,
          },
        },
      });
      const subscriptionId = response.data.destinationSubscription.id;
      this.setSubscriptionId(subscriptionId);
    },
    async deactivate() {
      const destination = this.getDestinationId();
      const subscription = this.getSubscriptionId();
      await this.segmentApp.deleteDestinationSubscription({
        destination,
        subscription,
      });
      await this.segmentApp.deleteDestination({
        destination,
      });
    },
  },
  methods: {
    getDestination() {
      return "actions-webhook";
    },
    setDestinationId(id) {
      this.db.set("destinationId", id);
    },
    getDestinationId() {
      return this.db.get("destinationId");
    },
    setSubscriptionId(id) {
      this.db.set("subscriptionId", id);
    },
    getSubscriptionId() {
      return this.db.get("subscriptionId");
    },
    async findDestinationMetadataId() {
      const params = {
        pagination: {
          count: 200,
        },
      };
      do {
        const {
          data: {
            destinationsCatalog, pagination,
          },
        } = await this.segmentApp.getDestinationsCatalog({
          params,
        });
        const destination = destinationsCatalog.find(({ slug }) => slug === this.getDestination());
        if (destination) {
          return destination.id;
        }
        params.pagination.cursor = pagination?.next;
      } while (params.pagination.cursor);
    },
    async findMetadataId() {
      const destinationMetadataId = await this.findDestinationMetadataId();
      const { data: { destinationMetadata } } =  await this.segmentApp.getDestinationMetadata({
        destinationMetadataId,
      });
      if (!destinationMetadata?.id) {
        throw new Error(`MetadataId for ${this.getDestination()} not found.`);
      }
      return destinationMetadata.id;
    },
    async findActionId(destination) {
      const { data } = await this.segmentApp.getDestination({
        destination,
      });
      return data.destination.metadata.actions[0].id;
    },
  },
  async run(event) {
    this.http.respond({
      status: 200,
    });

    this.$emit(event, {
      id: Date.now(),
      summary: "Received event",
      ts: Date.now(),
    });
  },
};

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
Segment	`segmentApp`	`app`	This component uses the Segment 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.
Workspace	`workspace`	`string`	Select a value from the drop down menu.
Source	`source`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	Defines the display name of the Destination
Trigger	`trigger`	`string`	Destination FQL Statement. Filter Query Language

Trigger Authentication#

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

Segment's APIs are accessed programmatically using access tokens, as well as write keys.

Access Token

Create access tokens via the Access Management page in your account: https://app.segment.com/{your-workspace-name}/settings/access-management. See "Get a Token" for more details. Please note, that you must be on a Team or Business plan to create an access token.

Write Key

You will also need to find your write key, which is a unique identifier for your Source. To find a write key, you first need to create a non-Cloud Source such as a website, server, or mobile source. (Cloud-sources do not have write keys, as they use a token or key from your account with that service.) Then, in the Source, go to “Settings’, and then go to “API Keys”. See "Locating Your Write Key" for more details.

About Segment#

Customer data platform

Action#

Create Payment Reference on ifthenpay

Description:Generates a Multibanco or MB WAY payment reference with a specified amount, entity code, and deadline. [See the documentation](https://ifthenpay.com/docs/en/)

Version:0.0.1

Key:ifthenpay-create-payment-reference

View on GitHub

Action Code#

import { PAYMENT_METHOD_OPTIONS } from "../../common/constants.mjs";
import ifthenpay from "../../ifthenpay.app.mjs";

export default {
  key: "ifthenpay-create-payment-reference",
  name: "Create Payment Reference",
  description: "Generates a Multibanco or MB WAY payment reference with a specified amount, entity code, and deadline. [See the documentation](https://ifthenpay.com/docs/en/)",
  version: "0.0.1",
  type: "action",
  props: {
    ifthenpay,
    paymentMethod: {
      type: "string",
      label: "Payment Method",
      description: "The payment method to use for Ifthenpay (e.g., MB WAY, Multibanco)",
      options: PAYMENT_METHOD_OPTIONS,
      reloadProps: true,
    },
    mbKey: {
      propDefinition: [
        ifthenpay,
        "mbKey",
      ],
      hidden: true,
    },
    mbWayKey: {
      propDefinition: [
        ifthenpay,
        "mbWayKey",
      ],
      hidden: true,
    },
    orderId: {
      type: "string",
      label: "Order Id",
      description: "Payment identifier defined by the client (e.g., invoice number, order number, etc.)",
    },
    amount: {
      type: "string",
      label: "Amount",
      description: "The amount to be paid with decimal separator \".\"",
    },
    mobileNumber: {
      type: "string",
      label: "Mobile Number",
      description: "Place the country code before the mobile number without any spaces (use '#'' to separate the country code from the mobile number - p.e. 351#912345678)",
      hidden: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "Description of the payment, with a maximum length of 200 characters",
      optional: true,
    },
    url: {
      type: "string",
      label: "URL",
      description: "URL address, with a maximum length of 200 characters",
      optional: true,
      hidden: true,
    },
    clientCode: {
      type: "string",
      label: "Client Code",
      description: "Client's code, with a maximum length of 200 characters",
      optional: true,
      hidden: true,
    },
    clientName: {
      type: "string",
      label: "Client Name",
      description: "Client's name, with a maximum length of 200 characters",
      optional: true,
      hidden: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "The Client's name.",
      optional: true,
    },
    clientUsername: {
      type: "string",
      label: "Client Username",
      description: "Client's username, with a maximum length of 200 characters",
      optional: true,
      hidden: true,
    },
    clientPhone: {
      type: "string",
      label: "Client Phone",
      description: "Client's cell phone or phone number, with a maximum length of 200 characters",
      optional: true,
      hidden: true,
    },
    expiryDays: {
      type: "integer",
      label: "Expiry Days",
      description: "How many days the payment reference is valid for. [See the documentation](https://ifthenpay.com/docs/en/api/multibanco/#tag/multibanco/POST/init) for further details.",
      optional: true,
      hidden: true,
    },
  },
  async additionalProps(props) {
    const isMb = this.paymentMethod === "Multibanco";
    props.mbKey.hidden = !isMb;
    props.mbWayKey.hidden = isMb;
    props.mobileNumber.hidden = isMb;
    props.url.hidden = isMb;
    props.clientCode.hidden = isMb;
    props.clientName.hidden = isMb;
    props.email.label = "Client Email";
    props.email.description = "Client's email address, with a maximum length of 200 characters";
    props.clientUsername.hidden = isMb;
    props.clientPhone.hidden = isMb;
    props.expiryDays.hidden = isMb;
    return {};
  },
  async run({ $ }) {
    const response = await this.ifthenpay.generatePaymentReference({
      $,
      paymentMethod: this.paymentMethod,
      data: {
        mbKey: this.mbKey,
        mbWayKey: this.mbWayKey,
        orderId: this.orderId,
        amount: parseFloat(this.amount),
        mobileNumber: this.mobileNumber,
        email: this.email,
        description: this.description,
        url: this.url,
        clientCode: this.clientCode,
        clientName: this.clientName,
        clientUsername: this.clientUsername,
        clientPhone: this.clientPhone,
        expiryDays: this.expiryDays,
        expirationDate: this.expirationDate,
        clientEmail: this.email,
      },
    });

    $.export("$summary", `Successfully created payment reference with Order ID: ${response.OrderId}`);
    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
ifthenpay	`ifthenpay`	`app`	This component uses the ifthenpay app.
Payment Method	`paymentMethod`	`string`	Select a value from the drop down menu:`MB WAYMultibanco`
Order Id	`orderId`	`string`	Payment identifier defined by the client (e.g., invoice number, order number, etc.)
Amount	`amount`	`string`	The amount to be paid with decimal separator "."
Description	`description`	`string`	Description of the payment, with a maximum length of 200 characters
Email	`email`	`string`	The Client's name.

Action Authentication#

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

About ifthenpay#

Digital Payments Digitais for your company

More Ways to Connect ifthenpay + Segment#

Other Popular Integrations#

Issue Refund with ifthenpay API on Webhook Destination (Instant) from Segment API

Segment + ifthenpay

Try it

Associate one identity with another with Segment API on New Payment Completed from ifthenpay API

ifthenpay + Segment

Try it

Associate an identified user with a group with Segment API on New Payment Completed from ifthenpay API

ifthenpay + Segment

Try it

Identify a user, tie them to their actions and record traits about them with Segment API on New Payment Completed from ifthenpay API

ifthenpay + Segment

Try it

Record page views on your website with Segment API on New Payment Completed from ifthenpay API

ifthenpay + Segment

Try it

Popular Triggers#

Webhook Destination (Instant) from the Segment API

Send events to a webhook. Requires a Team or Business account.

Try it

New Payment Completed from the ifthenpay API

Emit new event when a payment is successfully completed through Ifthenpay. See the documentation

Try it

Popular Actions#

Associate an identified user with a group with the Segment API

Group lets you associate an identified user with a group (note requires userId or anonymousId). See the docs here

Try it

Associate one identity with another with the Segment API

Alias is how you associate one identity with another. See the docs here

Try it

Identify a user, tie them to their actions and record traits about them with the Segment API

Identify lets you tie a user to their actions and record traits about them. It includes a unique User ID and any optional traits you know about them (note requires userId or anonymousId). See the docs here

Try it

Record page views on your website with the Segment API

The page method lets you record page views on your website, along with optional extra information about the page being viewed (note requires userId or anonymousId). See the docs here

Try it

Record whenever a user sees a screen with the Segment API

The screen method let you record whenever a user sees a screen of your mobile app (note requires userId or anonymousId). See the docs here

Try it