← Front

Import Message 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
Import Message 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 Import Message with the Front API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Import Message action
    1. Connect your Front account
    2. Select a Inbox ID
    3. Configure Handle
    4. Optional- Configure Name
    5. Optional- Select a Author ID
    6. Configure To
    7. Optional- Configure CC
    8. Optional- Configure BCC
    9. Optional- Configure Subject
    10. Configure Body
    11. Select a Body Format
    12. Configure External ID
    13. Configure Created At
    14. Optional- Select a Type
    15. Select a Assignee ID
    16. Optional- Select one or more Tag IDs
    17. Optional- Select a Thread Ref
    18. Configure Is Inbound
    19. Optional- Configure Is Archive
    20. Optional- Configure Should Skip Rules
  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

Import Message with Front API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Front
 
Try it
Import Message with Front API on New Item in Feed from RSS API
RSS + Front
 
Try it
Import Message with Front API on New Message from Discord API
Discord + Front
 
Try it
Import Message with Front API on New Message In Channels from Slack API
Slack + Front
 
Try it
Import Message with Front API on New Message in Channel from Discord Bot API
Discord Bot + 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.

Import Message on Front
Description:Appends a new message into an inbox. [See the docs here](https://dev.frontapp.com/reference/import-inbox-message).
Version:0.1.3
Key:frontapp-import-message

Code

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

export default {
  key: "frontapp-import-message",
  name: "Import Message",
  description: "Appends a new message into an inbox. [See the docs here](https://dev.frontapp.com/reference/import-inbox-message).",
  version: "0.1.3",
  type: "action",
  props: {
    frontApp,
    inboxId: {
      propDefinition: [
        frontApp,
        "inboxId",
      ],
    },
    handle: {
      type: "string",
      label: "Handle",
      description: "Handle used to reach the contact. Can be an email address, a twitter, handle, a phone number, custom handle ...",
    },
    name: {
      type: "string",
      label: "Name",
      description: "Name of the contact.",
      optional: true,
    },
    authorId: {
      propDefinition: [
        frontApp,
        "teammateId",
      ],
      label: "Author ID",
      description: "ID of the teammate who is the author of the message. Ignored if the message is inbound.",
      optional: true,
    },
    to: {
      propDefinition: [
        frontApp,
        "to",
      ],
    },
    cc: {
      propDefinition: [
        frontApp,
        "cc",
      ],
    },
    bcc: {
      propDefinition: [
        frontApp,
        "bcc",
      ],
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "Subject of the message.",
      optional: true,
    },
    body: {
      type: "string",
      label: "Body",
      description: "Body of the message.",
    },
    bodyFormat: {
      propDefinition: [
        frontApp,
        "bodyFormat",
      ],
    },
    externalId: {
      type: "string",
      label: "External ID",
      description: "External identifier of the message. Front won't import two messages with the same external ID.",
    },
    createdAt: {
      type: "integer",
      label: "Created At",
      description: "Date at which the message has been sent or received. A timestamp is expected as in `1655507769`",
      default: Math.floor(Date.now() / 1000),
    },
    type: {
      type: "string",
      label: "Type",
      description: "Type of the message to import. Can be one of: `email`, `sms`, `intercom`, `custom`. (Default: `email`)",
      optional: true,
      options: [
        "email",
        "sms",
        "intercom",
        "custom",
      ],
    },
    assigneeId: {
      propDefinition: [
        frontApp,
        "teammateId",
      ],
      label: "Assignee ID",
      description: "ID of the teammate who will be assigned to the conversation.",
    },
    tags: {
      propDefinition: [
        frontApp,
        "tagIds",
      ],
      description: "List of tag names to add to the conversation (unknown tags will automatically be created)",
    },
    threadRef: {
      propDefinition: [
        frontApp,
        "threadRef",
      ],
    },
    isInbound: {
      type: "boolean",
      label: "Is Inbound",
      description: "Whether or not the message is received (inbound) or sent (outbound) by you",
    },
    isArchive: {
      type: "boolean",
      label: "Is Archive",
      description: "Whether or not the message should be directly archived once imported. (Default: true)",
      optional: true,
    },
    shouldSkipRules: {
      type: "boolean",
      label: "Should Skip Rules",
      description: "Whether or not the rules should apply to this message. (Default: true)",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      inboxId,
      handle,
      name,
      authorId,
      subject,
      body,
      bodyFormat,
      externalId,
      createdAt,
      type,
      assigneeId,
      threadRef,
      isArchive,
      isInbound,
      shouldSkipRules,
    } = this;

    const to = utils.parse(this.to);
    const cc = utils.parse(this.cc);
    const bcc = utils.parse(this.bcc);
    const tags = utils.parse(this.tags);

    const data = {
      sender: {
        author_id: authorId,
        name,
        handle,
      },
      to,
      cc,
      bcc,
      subject,
      body,
      body_format: bodyFormat,
      external_id: externalId,
      created_at: createdAt,
      type,
      assignee_id: assigneeId,
      tags,
      metadata: {
        thread_ref: threadRef,
        is_inbound: isInbound,
        is_archived: isArchive,
        should_skip_rules: shouldSkipRules,
      },
    };

    const response =
      await this.frontApp.importMessage({
        inboxId,
        data,
      });

    const { message_uid: messageId } = response;

    $.export("$summary", `Successfully imported message with ID ${messageId}`);

    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.
Inbox IDinboxIdstringSelect a value from the drop down menu.
Handlehandlestring

Handle used to reach the contact. Can be an email address, a twitter, handle, a phone number, custom handle ...

Namenamestring

Name of the contact.

Author IDauthorIdstringSelect a value from the drop down menu.
Totostring[]

List of recipient handles who received the message.

CCccstring[]

List of recipient handles who received a copy of the message.

BCCbccstring[]

List of the recipeient handles who received a blind copy of the message.

Subjectsubjectstring

Subject of the message.

Bodybodystring

Body of the message.

Body FormatbodyFormatstringSelect a value from the drop down menu:htmlmarkdown
External IDexternalIdstring

External identifier of the message. Front won't import two messages with the same external ID.

Created AtcreatedAtinteger

Date at which the message has been sent or received. A timestamp is expected as in 1655507769

TypetypestringSelect a value from the drop down menu:emailsmsintercomcustom
Assignee IDassigneeIdstringSelect a value from the drop down menu.
Tag IDstagsstring[]Select a value from the drop down menu.
Thread RefthreadRefstringSelect a value from the drop down menu.
Is InboundisInboundboolean

Whether or not the message is received (inbound) or sent (outbound) by you

Is ArchiveisArchiveboolean

Whether or not the message should be directly archived once imported. (Default: true)

Should Skip RulesshouldSkipRulesboolean

Whether or not the rules should apply to this message. (Default: true)

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

Receive Custom Messages with the Front API

Receive a custom message in Front. 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