[Data] Parse JSON with Formatting API on New Customer (Instant) from Helpspace API

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

Trigger workflow on

New Customer (Instant) from the Helpspace API

Next, do this

[Data] Parse JSON 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 Helpspace 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 Customer (Instant) trigger
1. Connect your Helpspace account
Configure the [Data] Parse JSON 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 Customer (Instant) on Helpspace

Description:Emit new event when a new customer signs up on Helpspace. Note: Users may only have one active Helpspace webhook at a time. [See the documentation](https://documentation.helpspace.com/article/340/webhook)

Version:0.0.1

Key:helpspace-new-customer

View on GitHub

Helpspace Overview#

The Helpspace API facilitates seamless integration of customer support functionalities into various platforms. With Pipedream, you can harness this API to automate ticket tracking, customer communication, and support resource management. By connecting Helpspace to other apps, you can streamline support workflows, sync data across services, and even trigger actions based on customer interactions or support metrics.

Trigger Code#

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

export default {
  ...common,
  key: "helpspace-new-customer",
  name: "New Customer (Instant)",
  description: "Emit new event when a new customer signs up on Helpspace. Note: Users may only have one active Helpspace webhook at a time. [See the documentation](https://documentation.helpspace.com/article/340/webhook)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTrigger() {
      const baseTrigger = this.getBaseTrigger();
      return {
        ...baseTrigger,
        customer: {
          ...baseTrigger.customer,
          created: true,
        },
      };
    },
    generateMeta(customer) {
      return {
        id: customer.id,
        summary: `New Customer ${customer.name}`,
        ts: Date.parse(customer.created_at),
      };
    },
  },
  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
Helpspace	`helpspace`	`app`	This component uses the Helpspace 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.

Trigger Authentication#

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

To retrieve your Client ID and Access Token,

Navigate to your HelpSpace account and sign in
Go to “Settings” > “Access Tokens”

About Helpspace#

Simplify your customer support! Use Helpspace’s shared inbox to organize all incoming customer messages in one place for efficient teamwork.

Action#

[Data] Parse JSON on Formatting

Description:Parse a JSON string

Version:0.0.5

Key:formatting-parse-json

View on GitHub

Action Code#

import { defineAction } from "@pipedream/types";
import app from "../../app/formatting.app.mjs";
export default defineAction({
    name: "[Data] Parse JSON",
    description: "Parse a JSON string",
    key: "formatting-parse-json",
    version: "0.0.5",
    type: "action",
    props: {
        app,
        input: {
            label: "Input",
            description: "A valid JSON format string to be parsed.",
            type: "string",
        },
    },
    async run({ $ }) {
        try {
            const result = JSON.parse(this.input);
            $.export("$summary", "Successfully parsed JSON string");
            return result;
        }
        catch (err) {
            throw new Error("Error parsing input as JSON: " + err.toString());
        }
    },
});