[Data] Convert JSON to String with Formatting API on New Conversation Assigned (Instant) from Help Scout API

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

Trigger workflow on

New Conversation Assigned (Instant) from the Help Scout API

Next, do this

[Data] Convert JSON to String with the Formatting 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 Help Scout trigger and Formatting action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Conversation Assigned (Instant) trigger
1. Connect your Help Scout account
2. Optional- Configure Label
Configure the [Data] Convert JSON to String action
1. Connect your Formatting account
2. Configure Input
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 Conversation Assigned (Instant) on Help Scout

Description:Emit new event when a conversation is assigned to an agent. [See the documentation](https://developer.helpscout.com/)

Version:0.0.1

Key:help_scout-new-conversation-assigned-instant

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.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "help_scout-new-conversation-assigned-instant",
  name: "New Conversation Assigned (Instant)",
  description: "Emit new event when a conversation is assigned to an agent. [See the documentation](https://developer.helpscout.com/)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEventType() {
      return [
        "convo.assigned",
      ];
    },
    getSummary(body) {
      return `New conversation assigned to ${body.assignee.email}`;
    },
  },
  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
Help Scout	`helpScout`	`app`	This component uses the Help Scout app.
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Label	`label`	`string`	Label associated with this WebHook for better clarity.

Trigger 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:

About Help Scout#

Simple Customer Service Software and Education

Action#

[Data] Convert JSON to String on Formatting

Description:Convert an object to a JSON format string

Version:0.0.5

Key:formatting-convert-json-to-string

View on GitHub

Action Code#

import { defineAction } from "@pipedream/types";
import app from "../../app/formatting.app.mjs";
export default defineAction({
    name: "[Data] Convert JSON to String",
    description: "Convert an object to a JSON format string",
    key: "formatting-convert-json-to-string",
    version: "0.0.5",
    type: "action",
    props: {
        app,
        input: {
            label: "Input",
            description: "An object to be serialized to a JSON format string.",
            type: "object",
        },
    },
    async run({ $ }) {
        try {
            const result = JSON.stringify(this.input);
            $.export("$summary", "Successfully convert object to JSON string");
            return result;
        }
        catch (err) {
            throw new Error("Error serializing object to JSON string: " + err.toString());
        }
    },
});