Import Message with Front API on New Client (Instant) from ServiceM8 API

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

Trigger workflow on

New Client (Instant) from the ServiceM8 API

Next, do this

Import 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 ServiceM8 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 Client (Instant) trigger
1. Connect your ServiceM8 account
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. Optional- 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
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 Client (Instant) on ServiceM8

Description:Emit new event when a new client is created.

Version:0.0.2

Key:servicem8-new-client

View on GitHub

ServiceM8 Overview#

The ServiceM8 API allows businesses to streamline their field service management by automating tasks and integrating with other tools. Through Pipedream, you can harness this API to create custom workflows that trigger actions within ServiceM8 or sync data with other apps. Automate job scheduling, dispatching, invoicing, and more by reacting to events in real-time. Enhance productivity by connecting ServiceM8 to CRMs, accounting software, or custom databases, ensuring consistent and updated information across platforms.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  name: "New Client (Instant)",
  key: "servicem8-new-client",
  description: "Emit new event when a new client is created.",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getMeta({ entry }) {
      if (entry) {
        const {
          uuid, time,
        } = entry[0];

        const eventTime = time || new Date().getTime();

        return {
          id: uuid,
          summary: `New client created with uuid: ${uuid}`,
          ts: eventTime,
        };
      }
    },
    getParams() {
      return {
        object: "Company",
        fields: "uuid",
      };
    },
  },
};

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
ServiceM8	`servicem8`	`app`	This component uses the ServiceM8 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.

Trigger Authentication#

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

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

staff_locationsstaff_activitypublish_smspublish_emailvendorvendor_logovendor_emailread_locationsmanage_locationsread_staffmanage_staffread_customersmanage_customersread_customer_contactsmanage_customer_contactsread_jobsmanage_jobscreate_jobsread_job_contactsmanage_job_contactsread_job_materialsmanage_job_materialsread_job_categoriesmanage_job_categoriesread_job_queuesmanage_job_queuesread_tasksmanage_tasksread_schedulemanage_scheduleread_inventorymanage_inventoryread_job_notespublish_job_notesread_job_photospublish_job_photosread_job_attachmentspublish_job_attachmentsread_inboxread_messagesmanage_notificationsmanage_templatesmanage_badgesread_assetsmanage_assets

About ServiceM8#

Field service software

Action#

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.7

Key:frontapp-import-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-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.7",
  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.",
      optional: true,
    },
    tags: {
      propDefinition: [
        frontApp,
        "tagIds",
      ],
      optional: true,
      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;
  },
};

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.
Inbox ID	`inboxId`	`string`	Select a value from the drop down menu.
Handle	`handle`	`string`	Handle used to reach the contact. Can be an email address, a twitter, handle, a phone number, custom handle ...
Name	`name`	`string`	Name of the contact.
Author ID	`authorId`	`string`	Select a value from the drop down menu.
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.
Subject	`subject`	`string`	Subject of the message.
Body	`body`	`string`	Body of the message.
Body Format	`bodyFormat`	`string`	Select a value from the drop down menu:`htmlmarkdown`
External ID	`externalId`	`string`	External identifier of the message. Front won't import two messages with the same external ID.
Created At	`createdAt`	`integer`	Date at which the message has been sent or received. A timestamp is expected as in `1655507769`
Type	`type`	`string`	Select a value from the drop down menu:`emailsmsintercomcustom`
Assignee ID	`assigneeId`	`string`	Select a value from the drop down menu.
Tag IDs	`tags`	`string[]`	Select a value from the drop down menu.
Thread Ref	`threadRef`	`string`	Select a value from the drop down menu.
Is Inbound	`isInbound`	`boolean`	Whether or not the message is received (inbound) or sent (outbound) by you
Is Archive	`isArchive`	`boolean`	Whether or not the message should be directly archived once imported. (Default: true)
Should Skip Rules	`shouldSkipRules`	`boolean`	Whether or not the rules should apply to this message. (Default: true)

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:

About Front#

Customer communication platform

More Ways to Connect Front + ServiceM8#

Other Popular Integrations#

Import Message with Front API on New Job Completed (Instant) from ServiceM8 API

ServiceM8 + Front

Import Message with Front API on New Client (Instant) from ServiceM8 API

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

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,700+apps by most popular

1
-
24
of
2,700+
apps by most popular