Add Note to Conversation with Help Scout API on New Response Created from Chattermill API

Pipedream makes it easy to connect APIs for Help Scout, Chattermill and 2,900+ other apps remarkably fast.

Trigger workflow on

New Response Created from the Chattermill API

Next, do this

Add Note to Conversation with the Help Scout 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 Chattermill trigger and Help Scout action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Response Created trigger
1. Connect your Chattermill account
2. Configure timer
3. Select a Project ID
Configure the Add Note to Conversation action
1. Connect your Help Scout account
2. Select a Conversation ID
3. Configure Text
4. Optional- Select a User ID
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 Response Created on Chattermill

Description:Emit new event when a new response is created. [See the documentation](https://apidocs.chattermill.com/#3dd30375-7956-b872-edbd-873eef126b2d)

Version:0.0.1

Key:chattermill-new-response-created

View on GitHub

Trigger Code#

import chattermill from "../../chattermill.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import sampleEmit from "./test-event.mjs";

export default {
  key: "chattermill-new-response-created",
  name: "New Response Created",
  description: "Emit new event when a new response is created. [See the documentation](https://apidocs.chattermill.com/#3dd30375-7956-b872-edbd-873eef126b2d)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    chattermill,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    projectId: {
      propDefinition: [
        chattermill,
        "projectId",
      ],
    },
  },
  methods: {
    _getLastTs() {
      return this.db.get("lastTs");
    },
    _setLastTs(ts) {
      this.db.set("lastTs", ts);
    },
    generateMeta(response) {
      return {
        id: response.id,
        summary: `New response created: ${response.id}`,
        ts: Date.parse(response.created_at),
      };
    },
    async processEvent(max) {
      const lastTs = this._getLastTs();
      let maxTs = lastTs;

      const results = this.chattermill.paginate({
        fn: this.chattermill.listResponses,
        args: {
          projectId: this.projectId,
          params: {
            from: lastTs,
          },
        },
        resourceKey: "responses",
      });

      let responses = [];
      for await (const response of results) {
        if (!maxTs || Date.parse(response.created_at) > Date.parse(maxTs)) {
          maxTs = response.created_at;
        }
        responses.push(response);
      }

      if (!responses.length) {
        return;
      }

      this._setLastTs(maxTs);

      if (max && responses.length > max) {
        responses = responses.slice(0, max);
      }

      responses.forEach((response) => {
        const meta = this.generateMeta(response);
        this.$emit(response, meta);
      });
    },
  },
  hooks: {
    async deploy() {
      await this.processEvent(25);
    },
  },
  async run() {
    await this.processEvent();
  },
  sampleEmit,
};

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
Chattermill	`chattermill`	`app`	This component uses the Chattermill app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Project ID	`projectId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

About Chattermill#

Customer Feedback Analytics Software for Granular Insights

Action#

Add Note to Conversation on Help Scout

Description:Adds a note to an existing conversation in Help Scout. [See the documentation](https://developer.helpscout.com/mailbox-api/endpoints/conversations/threads/note/)

Version:0.0.3

Key:help_scout-add-note

View on GitHub

Help Scout Overview#

The Help Scout API provides programmatic access to customer support functionalities, allowing the automation of ticketing, customer communication, and reporting tasks. With this API, you can read and send messages, manage conversations, work with mailboxes, create and update customers’ information, and generate reports. Utilizing the API on Pipedream, you can automate workflows that respond to events in Help Scout in real-time, integrate customer support data with other business tools, and streamline support operations.

Action Code#

import helpScout from "../../help_scout.app.mjs";

export default {
  key: "help_scout-add-note",
  name: "Add Note to Conversation",
  description: "Adds a note to an existing conversation in Help Scout. [See the documentation](https://developer.helpscout.com/mailbox-api/endpoints/conversations/threads/note/)",
  version: "0.0.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    helpScout,
    conversationId: {
      propDefinition: [
        helpScout,
        "conversationId",
      ],
    },
    text: {
      propDefinition: [
        helpScout,
        "text",
      ],
    },
    userId: {
      propDefinition: [
        helpScout,
        "userId",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.helpScout.addNoteToConversation({
      $,
      conversationId: this.conversationId,
      data: {
        text: this.text,
        user: this.userId,
      },
    });
    $.export("$summary", `Successfully added note to conversation ID: ${this.conversationId}`);
    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
Help Scout	`helpScout`	`app`	This component uses the Help Scout app.
Conversation ID	`conversationId`	`string`	Select a value from the drop down menu.
Text	`text`	`string`	The content of the note.
User ID	`userId`	`string`	Select a value from the drop down menu.

Action Authentication#

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

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

Add Note to Conversation with Help Scout API on New Response Created from Chattermill API

Pipedream makes it easy to connect APIs for Help Scout, Chattermill and 2,900+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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