Search Contacts with Mautic API on New Company Created from CompanyHub API

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

Trigger workflow on

New Company Created from the CompanyHub API

Next, do this

Search Contacts with the Mautic 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 CompanyHub trigger and Mautic action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Company Created trigger
1. Connect your CompanyHub account
2. Configure timer
Configure the Search Contacts action
1. Connect your Mautic account
2. Configure Search Query
3. Optional- Configure Order By
4. Optional- Select a Order By Direction
5. Optional- Configure Is Published Only
6. Optional- Configure Minimal
7. Optional- Configure Where
8. Optional- Configure Order
9. Optional- Configure Max Results
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 Company Created on CompanyHub

Description:Emit new event when a new company is created. [See the documentation](https://companyhub.com/docs/api-documentation)

Version:0.0.1

Key:companyhub-new-company-created

View on GitHub

CompanyHub Overview#

The CompanyHub API offers a platform for seamless CRM automation, enabling you to streamline sales processes, manage customer interactions, and analyze data efficiently. With it, you can automate tasks like data entry, lead tracking, and follow-ups, saving time and eliminating manual errors. Pipedream's integration capabilities allow you to connect CompanyHub with other apps to create custom, automated workflows that trigger actions based on events, sync data across platforms, or generate real-time notifications.

Trigger Code#

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

export default {
  ...common,
  key: "companyhub-new-company-created",
  name: "New Company Created",
  description: "Emit new event when a new company is created. [See the documentation](https://companyhub.com/docs/api-documentation)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getResourceFn() {
      return this.companyhub.listCompanies;
    },
    getSummary(item) {
      return `New Company: ${item.Name}`;
    },
  },
  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
CompanyHub	`companyhub`	`app`	This component uses the CompanyHub app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

To access your API Key and Subdomain, sign into your CompanyHub account, then navigate to Settings > Integrations.

About CompanyHub#

CompanyHub is a sales automation CRM for sales teams that can be completely tailored for your industry.

Action#

Search Contacts on Mautic

Description:Gets a list of contacts by a search term. [See docs](https://developer.mautic.org/#list-contacts)

Version:0.2.0

Key:mautic-search-contacts

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.

Action Code#

import mautic from "../../mautic.app.mjs";
import {
  pick,
  pickBy,
} from "lodash-es";

export default {
  key: "mautic-search-contacts",
  name: "Search Contacts",
  description: "Gets a list of contacts by a search term. [See docs](https://developer.mautic.org/#list-contacts)",
  version: "0.2.0",
  type: "action",
  props: {
    mautic,
    search: {
      propDefinition: [
        mautic,
        "search",
      ],
    },
    orderBy: {
      propDefinition: [
        mautic,
        "orderBy",
      ],
    },
    orderByDir: {
      propDefinition: [
        mautic,
        "orderByDir",
      ],
    },
    publishedOnly: {
      propDefinition: [
        mautic,
        "publishedOnly",
      ],
    },
    minimal: {
      propDefinition: [
        mautic,
        "minimal",
      ],
    },
    where: {
      propDefinition: [
        mautic,
        "where",
      ],
    },
    order: {
      propDefinition: [
        mautic,
        "order",
      ],
    },
    maxResults: {
      propDefinition: [
        mautic,
        "maxResults",
      ],
    },
  },
  async run({ $ }) {
    const params = pickBy(pick(this, [
      "search",
      "orderBy",
      "orderByDir",
      "publishedOnly",
      "minimal",
      "where",
      "order",
    ]));

    const paginator = this.mautic.paginate({
      $,
      fn: this.mautic.listContacts,
      maxResults: this.maxResults,
      params,
    });

    const results = this.mautic.listAll(paginator);
    const suffix = results.length === 1
      ? ""
      : "s";
    $.export("$summary", `Retrieved ${results.length} contact${suffix}`);
    return results;
  },
};

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
Mautic	`mautic`	`app`	This component uses the Mautic app.
Search Query	`search`	`string`	String or search command to filter entities by
Order By	`orderBy`	`string`	Column to sort by. Can use any column listed in the response in `snake_case`
Order By Direction	`orderByDir`	`string`	Select a value from the drop down menu:`ascdesc`
Is Published Only	`publishedOnly`	`boolean`	Only return currently published entities
Minimal	`minimal`	`boolean`	Return only array of entities without additional lists in it
Where	`where`	`any`	An array of advanced `where` conditions
Order	`order`	`any`	An array of advanced `order` statements
Max Results	`maxResults`	`integer`	Limit number of entities to return

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

Search Contacts with Mautic API on New Company Created from CompanyHub API

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

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

Developers ♥ Pipedream

1-24of2,800+apps by most popular

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