[Data] Convert JSON to String with Formatting API on New Form Submission from Mautic API

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

Trigger workflow on

New Form Submission from the Mautic 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 Mautic 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 Form Submission trigger
1. Connect your Mautic account
2. Select a Form ID
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 Form Submission on Mautic

Description:Emit new event when a form is submitted. [See the docs](https://developer.mautic.org/#webhooks)

Version:0.0.1

Key:mautic-new-form-submission

View on GitHub

Mautic Overview#

The Mautic API empowers marketers to automate and integrate a wide range of marketing tasks directly into Pipedream workflows. With Mautic's API, you can manage contacts, campaigns, emails, and reports, and use triggers to automate responses based on user behavior. It's a robust tool to align marketing efforts with real-time data and actions, making it possible to personalize communication, streamline follow-ups, and ultimately drive conversions with less manual effort.

Trigger Code#

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

export default {
  ...base,
  key: "mautic-new-form-submission",
  name: "New Form Submission",
  description: "Emit new event when a form is submitted. [See the docs](https://developer.mautic.org/#webhooks)",
  version: "0.0.1",
  type: "source",
  props: {
    ...base.props,
    formId: {
      propDefinition: [
        base.props.mautic,
        "formId",
      ],
      description: "ID of the form to get submissions",
    },
  },
  methods: {
    ...base.methods,
    getEventType() {
      return constants.EVENT_TYPES.FORM_SUBMITTED;
    },
    getEventListFn() {
      return {
        fn: this.mautic.listFormSubmissions,
        pathVariables: {
          formId: this.formId,
        },
      };
    },
    isRelevant() {
      return true;
    },
    generateMeta(form) {
      const {
        id,
        dateSubmitted: ts,
      } = form;
      const formName = form.form.name;
      return {
        id,
        ts,
        summary: `New form submission for ${formName}`,
      };
    },
    emitEvent(event) {
      const submission = event.submission
        ? event.submission
        : event;
      const meta = this.generateMeta(submission);
      console.log(`Emitting event - ${meta.summary}`);
      this.$emit(submission, meta);
    },
  },
};

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
Mautic	`mautic`	`app`	This component uses the Mautic 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.
Form ID	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

About Mautic#

Open Source Marketing Automation

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());
        }
    },
});