← Front

Receive Custom Messages with Front API

Pipedream makes it easy to connect APIs for Front and 900+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Receive Custom Messages with the Front API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to Receive Custom Messages with the Front API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Receive Custom Messages action
    1. Connect your Front account
    2. Select a Channel ID
    3. Configure Handle
    4. Optional- Select a Contact ID
    5. Optional- Configure Sender Name
    6. Optional- Configure Subject
    7. Optional- Select a Body Format
    8. Configure Body
    9. Optional- Select a Thread Ref
    10. Optional- Configure Headers
    11. Optional- Configure Attachments
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Receive Custom Messages with Front API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Front
 
Try it
Receive Custom Messages with Front API on New Message from Discord API
Discord + Front
 
Try it
Receive Custom Messages with Front API on New Message in Channel from Discord Bot API
Discord Bot + Front
 
Try it
Receive Custom Messages with Front API on New Submission from Typeform API
Typeform + Front
 
Try it
Receive Custom Messages with Front API on Custom Events from Zoom API
Zoom + Front
 
Try it

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is 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.

Receive Custom Messages on Front
Description:Receive a custom message in Front. [See the docs here](https://dev.frontapp.com/reference/post_channels-channel-id-incoming-messages).
Version:0.0.1
Key:frontapp-receive-custom-messages

Code

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

export default {
  key: "frontapp-receive-custom-messages",
  name: "Receive Custom Messages",
  description: "Receive a custom message in Front. [See the docs here](https://dev.frontapp.com/reference/post_channels-channel-id-incoming-messages).",
  version: "0.0.1",
  type: "action",
  props: {
    frontApp,
    channelId: {
      propDefinition: [
        frontApp,
        "channelId",
        () => ({
          filter: (channel) => [
            "custom",
          ].includes(channel.type),
        }),
      ],
    },
    handle: {
      type: "string",
      label: "Handle",
      description: "Handle of the sender. It can be any string used to uniquely identify the sender",
    },
    contactId: {
      propDefinition: [
        frontApp,
        "contactId",
      ],
      optional: true,
    },
    senderName: {
      type: "string",
      label: "Sender Name",
      description: "Name of the sender",
      optional: true,
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "Subject of the message",
      optional: true,
    },
    bodyFormat: {
      propDefinition: [
        frontApp,
        "bodyFormat",
      ],
      optional: true,
    },
    body: {
      type: "string",
      label: "Body",
      description: "Body of the message",
    },
    threadRef: {
      propDefinition: [
        frontApp,
        "threadRef",
      ],
    },
    headers: {
      type: "object",
      label: "Headers",
      description: "Custom object where any internal information can be stored",
      optional: true,
    },
    attachments: {
      propDefinition: [
        frontApp,
        "attachments",
      ],
    },
  },
  async run({ $ }) {
    const {
      channelId,
      handle,
      contactId,
      senderName,
      subject,
      body,
      bodyFormat,
      threadRef,
      headers,
    } = this;

    const attachments = utils.parse(this.attachments);

    const hasAttachments = attachments?.length > 0;

    const sender = utils.emptyObjectToUndefined({
      contact_id: contactId,
      name: senderName,
      handle,
    });

    const metadata = utils.emptyObjectToUndefined({
      thread_ref: threadRef,
      headers,
    });

    const data = utils.reduceProperties({
      initialProps: {
        body,
        sender,
      },
      additionalProps: {
        body_format: bodyFormat,
        metadata,
        attachments: [
          attachments,
          hasAttachments,
        ],
        subject,
      },
    });

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

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

    $.export("$summary", `Successfully received message with ID ${response.message_uid}`);

    return response;
  },
};

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.
LabelPropTypeDescription
FrontfrontAppappThis component uses the Front app.
Channel IDchannelIdstringSelect a value from the drop down menu.
Handlehandlestring

Handle of the sender. It can be any string used to uniquely identify the sender

Contact IDcontactIdstringSelect a value from the drop down menu.
Sender NamesenderNamestring

Name of the sender

Subjectsubjectstring

Subject of the message

Body FormatbodyFormatstringSelect a value from the drop down menu:htmlmarkdown
Bodybodystring

Body of the message

Thread RefthreadRefstringSelect a value from the drop down menu.
Headersheadersobject

Custom object where any internal information can be stored

Attachmentsattachmentsstring[]

File paths of files previously downloaded in Pipedream E.g. (/tmp/my-image.jpg). Download a file to the /tmp directory

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:

About Front

Customer communication platform

More Ways to Use Front

Actions

Import Message with the Front API

Appends a new message into an inbox. See the docs here.

 
Try it
Send New Message with the Front API

Sends a new message from a channel. It will create a new conversation. See the docs here.

 
Try it
Update Conversation with the Front API

Updates a conversation. See the docs here.

 
Try it