Send New Message with Front API on New Webhook Event (Instant) from Payhere API

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

Trigger workflow on

New Webhook Event (Instant) from the Payhere API

Next, do this

Send New Message with the Front 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 Front 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 Send New Message action
1. Connect your Front account
2. Select a Channel ID
3. Select a Author ID
4. Optional- Configure Sender Name
5. Optional- Configure Subject
6. Configure Body
7. Optional- Configure Text
8. Optional- Configure Attachments
9. Optional- Select one or more Tag IDs
10. Optional- Configure Is Archive
11. Configure To
12. Optional- Configure CC
13. Optional- Configure BCC
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#

Send New Message on Front

Description:Sends a new message from a channel. It will create a new conversation. [See the docs here](https://dev.frontapp.com/reference/post_channels-channel-id-messages).

Version:0.2.6

Key:frontapp-send-new-message

View on GitHub

Front Overview#

The Front API empowers you to automate the handling of your team's email inbox, collaborate on conversations, and streamline communication workflows. By harnessing this API on Pipedream, you can craft custom integrations that trigger actions in Front in response to events, synchronize data across platforms, and augment your team's productivity with automated tasks. This can include creating or updating conversations and contacts, managing tags, or firing off custom automation rules within Front.

Action Code#

import utils from "../../common/utils.mjs";
import frontApp from "../../frontapp.app.mjs";

export default {
  key: "frontapp-send-new-message",
  name: "Send New Message",
  description: "Sends a new message from a channel. It will create a new conversation. [See the docs here](https://dev.frontapp.com/reference/post_channels-channel-id-messages).",
  version: "0.2.6",
  type: "action",
  props: {
    frontApp,
    channelId: {
      propDefinition: [
        frontApp,
        "channelId",
      ],
    },
    authorId: {
      propDefinition: [
        frontApp,
        "teammateId",
      ],
      label: "Author ID",
      description: "ID of the teammate on behalf of whom the answer is sent",
    },
    senderName: {
      type: "string",
      label: "Sender Name",
      description: "Name used for the sender info of the message",
      optional: true,
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "Subject of the message for email message",
      optional: true,
    },
    body: {
      type: "string",
      label: "Body",
      description: "Body of the message. Accepts HTML",
    },
    text: {
      type: "string",
      label: "Text",
      description: "Text version of the body for messages with non-text body",
      optional: true,
    },
    attachments: {
      propDefinition: [
        frontApp,
        "attachments",
      ],
    },
    optionsTagIds: {
      propDefinition: [
        frontApp,
        "tagIds",
      ],
      optional: true,
      description: "List of tag names to add to the conversation (unknown tags will automatically be created)",
    },
    optionsIsArchive: {
      type: "boolean",
      label: "Is Archive",
      description: "Archive the conversation right when sending the message (Default: true)",
      optional: true,
    },
    to: {
      propDefinition: [
        frontApp,
        "to",
      ],
    },
    cc: {
      propDefinition: [
        frontApp,
        "cc",
      ],
    },
    bcc: {
      propDefinition: [
        frontApp,
        "bcc",
      ],
    },
  },
  async run({ $ }) {
    const {
      channelId,
      authorId,
      senderName,
      subject,
      body,
      text,
      optionsIsArchive,
    } = this;

    const to = utils.parse(this.to);
    const cc = utils.parse(this.cc);
    const bcc = utils.parse(this.bcc);
    const tagIds = utils.parse(this.optionsTagIds);
    const attachments = utils.parse(this.attachments);

    const hasAttachments = utils.hasArrayItems(attachments);
    const hasCc = utils.hasArrayItems(cc);
    const hasBcc = utils.hasArrayItems(bcc);

    const data = utils.reduceProperties({
      initialProps: {
        to,
        body,
      },
      additionalProps: {
        cc: [
          cc,
          hasCc,
        ],
        bcc: [
          bcc,
          hasBcc,
        ],
        sender_name: senderName,
        subject,
        author_id: authorId,
        body,
        text,
        options: {
          tag_ids: tagIds,
          archive: optionsIsArchive ?? true,
        },
        attachments: [
          attachments,
          hasAttachments,
        ],
      },
    });

    const args = utils.reduceProperties({
      initialProps: {
        channelId,
        data,
      },
      additionalProps: {
        headers: [
          {
            "Content-Type": "multipart/form-data",
          },
          hasAttachments,
        ],
      },
    });

    const response = await this.frontApp.sendMessage(args);

    $.export("$summary", `Successfully sent new message to channel 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
Front	`frontApp`	`app`	This component uses the Front app.
Channel ID	`channelId`	`string`	Select a value from the drop down menu.
Author ID	`authorId`	`string`	Select a value from the drop down menu.
Sender Name	`senderName`	`string`	Name used for the sender info of the message
Subject	`subject`	`string`	Subject of the message for email message
Body	`body`	`string`	Body of the message. Accepts HTML
Text	`text`	`string`	Text version of the body for messages with non-text body
Attachments	`attachments`	`string[]`	File paths of files previously downloaded in Pipedream E.g. (`/tmp/my-image.jpg`). Download a file to the `/tmp` directory
Tag IDs	`optionsTagIds`	`string[]`	Select a value from the drop down menu.
Is Archive	`optionsIsArchive`	`boolean`	Archive the conversation right when sending the message (Default: true)
To	`to`	`string[]`	List of recipient handles who received the message.
CC	`cc`	`string[]`	List of recipient handles who received a copy of the message.
BCC	`bcc`	`string[]`	List of the recipeient handles who received a blind copy of the message.

Action Authentication#

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

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