Run Actor with Apify API on New Form Submission from Mautic API

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

Trigger workflow on

New Form Submission from the Mautic API

Next, do this

Run Actor with the Apify 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 Apify 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 Run Actor action
1. Connect your Apify account
2. Select a Actor ID
3. Select a Build
4. Configure Run Asynchronously
5. Optional- Configure Timeout
6. Optional- Configure Memory
7. Optional- Configure Max Items
8. Optional- Configure Max Total Charge USD
9. Optional- Configure Webhook
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#

Run Actor on Apify

Description:Performs an execution of a selected actor in Apify. [See the documentation](https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor)

Version:0.0.3

Key:apify-run-actor

View on GitHub

Apify Overview#

The Apify API unleashes the power to automate web scraping, process data, and orchestrate web automation workflows. By utilizing Apify on Pipedream, you can create dynamic serverless workflows to manage tasks like extracting data from websites, running browser automation, and scheduling these jobs to run autonomously. It integrates smoothly with Pipedream's capabilities to trigger actions on various other apps, store the results, and manage complex data flow with minimal setup.

Action Code#

/* eslint-disable no-unused-vars */
import apify from "../../apify.app.mjs";
import { parseObject } from "../../common/utils.mjs";
import { EVENT_TYPES } from "../../common/constants.mjs";

export default {
  key: "apify-run-actor",
  name: "Run Actor",
  description: "Performs an execution of a selected actor in Apify. [See the documentation](https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor)",
  version: "0.0.3",
  type: "action",
  props: {
    apify,
    actorId: {
      propDefinition: [
        apify,
        "actorId",
      ],
    },
    buildId: {
      propDefinition: [
        apify,
        "buildId",
        (c) => ({
          actorId: c.actorId,
        }),
      ],
      reloadProps: true,
    },
    runAsynchronously: {
      type: "boolean",
      label: "Run Asynchronously",
      description: "Set to `true` to run the actor asynchronously",
      reloadProps: true,
    },
    timeout: {
      type: "string",
      label: "Timeout",
      description: "Optional timeout for the run, in seconds. By default, the run uses a timeout specified in the default run configuration for the Actor.",
      optional: true,
    },
    memory: {
      type: "string",
      label: "Memory",
      description: "Memory limit for the run, in megabytes. The amount of memory can be set to a power of 2 with a minimum of 128. By default, the run uses a memory limit specified in the default run configuration for the Actor.",
      optional: true,
    },
    maxItems: {
      type: "string",
      label: "Max Items",
      description: "The maximum number of items that the Actor run should return. This is useful for pay-per-result Actors, as it allows you to limit the number of results that will be charged to your subscription. You can access the maximum number of items in your Actor by using the ACTOR_MAX_PAID_DATASET_ITEMS environment variable.",
      optional: true,
    },
    maxTotalChargeUsd: {
      type: "string",
      label: "Max Total Charge USD",
      description: "Specifies the maximum cost of the Actor run. This parameter is useful for pay-per-event Actors, as it allows you to limit the amount charged to your subscription. You can access the maximum cost in your Actor by using the ACTOR_MAX_TOTAL_CHARGE_USD environment variable.",
      optional: true,
    },
    webhook: {
      type: "string",
      label: "Webhook",
      description: "Specifies optional webhook associated with the Actor run, which can be used to receive a notification e.g. when the Actor finished or failed.",
      optional: true,
      reloadProps: true,
    },
  },
  methods: {
    getType(type) {
      return [
        "string",
        "object",
        "integer",
        "boolean",
      ].includes(type)
        ? type
        : "string[]";
    },
    async getSchema(buildId) {
      const { data: { inputSchema } } = await this.apify.getBuild(buildId);
      return JSON.parse(inputSchema);
    },
    async prepareData(data) {
      const newData = {};

      const { properties } = await this.getSchema(this.buildId);
      for (const [
        key,
        value,
      ] of Object.entries(data)) {
        const editor = properties[key].editor;
        newData[key] = (Array.isArray(value))
          ? value.map((item) => this.setValue(editor, item))
          : value;
      }
      return newData;
    },
    prepareOptions(value) {
      let options = [];
      if (value.enum && value.enumTitles) {
        for (const [
          index,
          val,
        ] of value.enum.entries()) {
          if (val) {
            options.push({
              value: val,
              label: value.enumTitles[index],
            });
          }
        }
      }
      return options.length
        ? options
        : undefined;
    },
    setValue(editor, item) {
      switch (editor) {
      case "requestListSources" : return {
        url: item,
      };
      case "pseudoUrls" : return {
        purl: item,
      };
      case "globs" : return {
        glob: item,
      };
      default: return item;
      }
    },
  },
  async additionalProps() {
    const props = {};
    if (this.buildId) {
      try {
        const {
          properties, required: requiredProps = [],
        } = await this.getSchema(this.buildId);

        for (const [
          key,
          value,
        ] of Object.entries(properties)) {
          if (value.editor === "hidden") continue;

          props[key] = {
            type: this.getType(value.type),
            label: value.title,
            description: value.description,
            optional: !requiredProps.includes(key),
          };
          const options = this.prepareOptions(value);
          if (options) props[key].options = options;
          if (value.default) {
            props[key].description += ` Default: \`${JSON.stringify(value.default)}\``;
            if (props[key].type !== "object") { // default values don't work properly for object props
              props[key].default = value.default;
            }
          }
        }
      } catch {
        props.properties = {
          type: "object",
          label: "Properties",
          description: "Properties to set for this actor",
        };
      }
      if (this.runAsynchronously) {
        props.outputRecordKey = {
          type: "string",
          label: "Output Record Key",
          description: "Key of the record from run's default key-value store to be returned in the response. By default, it is OUTPUT.",
          optional: true,
        };
      } else {
        props.waitForFinish = {
          type: "string",
          label: "Wait For Finish",
          description: "The maximum number of seconds the server waits for the run to finish. By default, it is 0, the maximum value is 60. If the build finishes in time then the returned run object will have a terminal status (e.g. SUCCEEDED), otherwise it will have a transitional status (e.g. RUNNING).",
          optional: true,
        };
      }
    }
    if (this.webhook) {
      props.eventTypes = {
        type: "string[]",
        label: "Event Types",
        description: "The types of events to send to the webhook",
        options: EVENT_TYPES,
      };
    }
    return props;
  },
  async run({ $ }) {
    const {
      getType,
      getSchema,
      prepareOptions,
      setValue,
      prepareData,
      apify,
      actorId,
      buildId,
      properties,
      runAsynchronously,
      outputRecordKey,
      timeout,
      memory,
      maxItems,
      maxTotalChargeUsd,
      waitForFinish,
      webhook,
      eventTypes,
      ...data
    } = this;

    const fn = runAsynchronously
      ? apify.runActorAsynchronously
      : apify.runActor;

    const response = await fn({
      actorId,
      data: properties
        ? parseObject(properties)
        : await prepareData(data),
      params: {
        outputRecordKey,
        timeout,
        memory,
        maxItems,
        maxTotalChargeUsd,
        waitForFinish,
        webhooks: webhook
          ? btoa(JSON.stringify([
            {
              eventTypes,
              requestUrl: webhook,
            },
          ]))
          : undefined,
      },
    });
    const summary = this.runAsynchronously
      ? `Successfully started actor run with ID: ${response.data.id}`
      : `Successfully ran actor with ID: ${this.actorId}`;
    $.export("$summary", `${summary}`);
    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
Apify	`apify`	`app`	This component uses the Apify app.
Actor ID	`actorId`	`string`	Select a value from the drop down menu.
Build	`buildId`	`string`	Select a value from the drop down menu.
Run Asynchronously	`runAsynchronously`	`boolean`	Set to `true` to run the actor asynchronously
Timeout	`timeout`	`string`	Optional timeout for the run, in seconds. By default, the run uses a timeout specified in the default run configuration for the Actor.
Memory	`memory`	`string`	Memory limit for the run, in megabytes. The amount of memory can be set to a power of 2 with a minimum of 128. By default, the run uses a memory limit specified in the default run configuration for the Actor.
Max Items	`maxItems`	`string`	The maximum number of items that the Actor run should return. This is useful for pay-per-result Actors, as it allows you to limit the number of results that will be charged to your subscription. You can access the maximum number of items in your Actor by using the ACTOR_MAX_PAID_DATASET_ITEMS environment variable.
Max Total Charge USD	`maxTotalChargeUsd`	`string`	Specifies the maximum cost of the Actor run. This parameter is useful for pay-per-event Actors, as it allows you to limit the amount charged to your subscription. You can access the maximum cost in your Actor by using the ACTOR_MAX_TOTAL_CHARGE_USD environment variable.
Webhook	`webhook`	`string`	Specifies optional webhook associated with the Actor run, which can be used to receive a notification e.g. when the Actor finished or failed.

Run Actor with Apify API on New Form Submission from Mautic API

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

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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