Unsubscribe Email with Firefish API on New or Updated Contact from HubSpot API

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

Trigger workflow on

New or Updated Contact from the HubSpot API

Next, do this

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

Select this integration
Configure the New or Updated Contact trigger
1. Connect your HubSpot account
2. Configure timer
3. Configure info
4. Optional- Select one or more Additional properties to retrieve
5. Optional- Select one or more Lists
6. Optional- Configure New Only
Configure the Unsubscribe Email action
1. Connect your Firefish account
2. Configure Email
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 or Updated Contact on HubSpot

Description:Emit new event for each new or updated contact in Hubspot.

Version:0.0.3

Key:hubspot-new-or-updated-contact

View on GitHub

HubSpot Overview#

The HubSpot API enables developers to integrate into HubSpots CRM, CMS, Conversations, and other features. It allows for automated management of contacts, companies, deals, and marketing campaigns, enabling custom workflows, data synchronization, and task automation. This streamlines operations and boosts customer engagement, with real-time updates for rapid response to market changes.

Trigger Code#

import common from "../common/common.mjs";
import {
  DEFAULT_LIMIT, DEFAULT_CONTACT_PROPERTIES,
} from "../../common/constants.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "hubspot-new-or-updated-contact",
  name: "New or Updated Contact",
  description: "Emit new event for each new or updated contact in Hubspot.",
  version: "0.0.3",
  dedupe: "unique",
  type: "source",
  props: {
    ...common.props,
    info: {
      type: "alert",
      alertType: "info",
      content: `Properties:\n\`${DEFAULT_CONTACT_PROPERTIES.join(", ")}\``,
    },
    properties: {
      propDefinition: [
        common.props.hubspot,
        "contactProperties",
        () => ({
          excludeDefaultProperties: true,
        }),
      ],
      label: "Additional properties to retrieve",
    },
    lists: {
      propDefinition: [
        common.props.hubspot,
        "lists",
      ],
      withLabel: false,
      optional: true,
    },
    newOnly: {
      type: "boolean",
      label: "New Only",
      description: "Emit events only for new contacts",
      default: false,
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getTs(contact) {
      return this.newOnly
        ? Date.parse(contact.createdAt)
        : Date.parse(contact.updatedAt);
    },
    generateMeta(contact) {
      const { id } = contact;
      const ts = this.getTs(contact);
      return {
        id: this.newOnly
          ? id
          : `${id}-${ts}`,
        summary: `Record ID: ${id}`,
        ts,
      };
    },
    async translateListIds(lists) {
      const listIds = [];
      for (const list of lists) {
        const { listId } = await this.hubspot.translateLegacyListId({
          params: {
            legacyListId: list,
          },
        });
        listIds.push(listId);
      }
      return listIds;
    },
    async isRelevant(contact, updatedAfter) {
      if (this.getTs(contact) < updatedAfter) {
        return false;
      }
      if (this.lists?.length) {
        const { results } = await this.hubspot.getMemberships({
          objectType: "contacts",
          objectId: contact.id,
        });
        const contactListIds = results?.map(({ listId }) => listId) || [];
        const listIds = await this.translateListIds(this.lists);
        for (const list of listIds) {
          if (contactListIds.includes(list)) {
            return true;
          }
        }
        return false;
      }
      return true;
    },
    getParams() {
      const { properties = [] } = this;
      return {
        data: {
          limit: DEFAULT_LIMIT,
          sorts: [
            {
              propertyName: "lastmodifieddate",
              direction: "DESCENDING",
            },
          ],
          properties: [
            ...DEFAULT_CONTACT_PROPERTIES,
            ...properties,
          ],
        },
        object: "contacts",
      };
    },
    async processResults(after, params) {
      await this.searchCRM(params, after);
    },
  },
  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
HubSpot	`hubspot`	`app`	This component uses the HubSpot app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Additional properties to retrieve	`properties`	`string[]`	Select a value from the drop down menu.
Lists	`lists`	`string[]`	Select a value from the drop down menu.
New Only	`newOnly`	`boolean`	Emit events only for new contacts

Trigger Authentication#

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

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

business-intelligencecrm.lists.readcrm.lists.writecrm.objects.companies.readcrm.objects.companies.writecrm.objects.contacts.readcrm.objects.contacts.writecrm.objects.deals.readcrm.objects.deals.writecrm.objects.quotes.readcrm.objects.quotes.writecrm.objects.owners.readcrm.schemas.companies.readcrm.schemas.companies.writecrm.schemas.contacts.readcrm.schemas.contacts.writecrm.schemas.deals.readcrm.schemas.deals.writecrm.schemas.quotes.readconversations.readcrm.importfilesformsforms-uploaded-filesintegration-syncoauthtimeline

About HubSpot#

HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.

Action#

Unsubscribe Email on Firefish

Description:Removes a particular contact or candidate from all existing firefish email subscriptions. [See the documentatio](https://developer.firefishsoftware.com/#002bb8c0-0b41-4016-b33c-026a46b499b2)

Version:0.0.1

Key:firefish-unsubscribe-email

View on GitHub

Action Code#

import firefish from "../../firefish.app.mjs";

export default {
  key: "firefish-unsubscribe-email",
  name: "Unsubscribe Email",
  description: "Removes a particular contact or candidate from all existing firefish email subscriptions. [See the documentatio](https://developer.firefishsoftware.com/#002bb8c0-0b41-4016-b33c-026a46b499b2)",
  version: "0.0.1",
  type: "action",
  props: {
    firefish,
    email: {
      type: "string",
      label: "Email",
      description: "The email address of the subscriber you want to remove",
    },
  },
  async run({ $ }) {
    const contacts = await this.firefish.searchContacts({
      $,
      params: {
        "email-address": this.email,
      },
    });
    for (const contact of contacts) {
      contact.EmailMarketing = false;
      await this.firefish.updateContact({
        $,
        contactId: contact.Ref,
        data: contact,
      });
    }

    const candidates = await this.firefish.searchCandidates({
      $,
      params: {
        "email-address": this.email,
      },
    });
    for (const candidate of candidates) {
      candidate.EmailMarketing = false;
      await this.firefish.updateCandidate({
        $,
        candidateId: candidate.Ref,
        data: candidate,
      });
    }

    $.export("$summary", `Successfully removed ${this.email} from email marketing`);
    return {
      contacts,
      candidates,
    };
  },
};

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
Firefish	`firefish`	`app`	This component uses the Firefish app.
Email	`email`	`string`	The email address of the subscriber you want to remove

Action Authentication#

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

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

Unsubscribe Email with Firefish API on New or Updated Contact from HubSpot API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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