Create or Update Person with Copper API on New Incoming Message from Heyy API

Pipedream makes it easy to connect APIs for Copper, Heyy and 2,900+ other apps remarkably fast.

Trigger workflow on

New Incoming Message from the Heyy API

Next, do this

Create or Update Person with the Copper 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 Heyy trigger and Copper action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Incoming Message trigger
1. Connect your Heyy account
2. Select a Channel ID
Configure the Create or Update Person action
1. Connect your Copper account
2. Configure Email
3. Optional- Configure Name
4. Optional- Configure Street Address
5. Optional- Configure City
6. Optional- Configure State
7. Optional- Configure Postal Code
8. Optional- Configure Country
9. Optional- Configure Phone
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 Incoming Message on Heyy

Description:Emit new event when a business gets a new incoming message. [See the documentation](https://documenter.getpostman.com/view/27408936/2sA2r3a6DW#eda04a28-4c5b-4709-a3f4-204dba6bcc18).

Version:0.0.1

Key:heyy-new-incoming-message-instant

View on GitHub

Trigger Code#

import app from "../../heyy.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "heyy-new-incoming-message-instant",
  name: "New Incoming Message",
  description: "Emit new event when a business gets a new incoming message. [See the documentation](https://documenter.getpostman.com/view/27408936/2sA2r3a6DW#eda04a28-4c5b-4709-a3f4-204dba6bcc18).",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    http: "$.interface.http",
    channelId: {
      propDefinition: [
        app,
        "channelId",
      ],
    },
  },
  hooks: {
    async activate() {
      const {
        createWebhook,
        http: { endpoint: url },
        channelId,
        setWebhookId,
      } = this;
      const response =
        await createWebhook({
          data: {
            url,
            type: "WHATSAPP_MESSAGE_RECEIVED",
            channelId,
          },
        });

      setWebhookId(response.data.id);
    },
    async deactivate() {
      const webhookId = this.getWebhookId();
      if (webhookId) {
        await this.deleteWebhook({
          webhookId,
        });
      }
    },
  },
  methods: {
    setWebhookId(value) {
      this.db.set(constants.WEBHOOK_ID, value);
    },
    getWebhookId() {
      return this.db.get(constants.WEBHOOK_ID);
    },
    generateMeta({ data: { whatsappMessage: resource } }) {
      return {
        id: resource.metaMessageId,
        summary: `New Incomming Message ${resource.metaMessageId}`,
        ts: parseInt(resource.timestamp),
      };
    },
    processResource(resource) {
      this.$emit(resource, this.generateMeta(resource));
    },
    createWebhook(args = {}) {
      return this.app.post({
        debug: true,
        path: "/api_webhooks",
        ...args,
      });
    },
    deleteWebhook({
      webhookId, ...args
    } = {}) {
      return this.app.delete({
        debug: true,
        path: `/api_webhooks/${webhookId}`,
        ...args,
      });
    },
  },
  async run({ body }) {
    this.processResource(body);
  },
};

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
Heyy	`app`	`app`	This component uses the Heyy 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.
Channel ID	`channelId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

About Heyy#

Connect with your customers on Whatsapp, SMS, Messenger and Instagram using automation.

Action#

Create or Update Person on Copper

Description:Creates a new person or updates an existing one based on email address. [See the documentation](https://developer.copper.com/people/create-a-new-person.html)

Version:0.0.2

Key:copper-create-update-person

View on GitHub

Copper Overview#

Copper CRM's API unlocks the potential to streamline customer relationship management through automation and integration. On Pipedream, this means you can leverage event-driven workflows to sync contacts, manage deals, and automate tasks. Think of it as connecting Copper's insights directly to other apps or databases, triggering events in real-time based on CRM updates or capturing fresh leads instantaneously.

Action Code#

import copper from "../../copper.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "copper-create-update-person",
  name: "Create or Update Person",
  description: "Creates a new person or updates an existing one based on email address. [See the documentation](https://developer.copper.com/people/create-a-new-person.html)",
  version: "0.0.2",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    copper,
    email: {
      type: "string",
      label: "Email",
      description: "Email address of the person. If email already exists, the person will be updated",
    },
    name: {
      type: "string",
      label: "Name",
      description: "Name of the contact. Required if creating a new person.",
      optional: true,
    },
    streetAddress: {
      type: "string",
      label: "Street Address",
      description: "Street address of the person",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "City address of the person",
      optional: true,
    },
    state: {
      type: "string",
      label: "State",
      description: "State address of the person",
      optional: true,
    },
    postalCode: {
      type: "string",
      label: "Postal Code",
      description: "Postal code of the person",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description: "Country of the person",
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "Phone number of the person",
      optional: true,
    },
  },
  async run({ $ }) {
    let response;
    const hasAddress = this.streetAddress
      || this.city
      || this.state
      || this.postalCode
      || this.country;
    const data = {
      emails: [
        {
          email: this.email,
          category: "work",
        },
      ],
      name: this.name,
      address: hasAddress && {
        street: this.streetAddress,
        city: this.city,
        state: this.state,
        postal_code: this.postalCode,
        country: this.country,
      },
      phone_numbers: this.phone && [
        {
          number: this.phone,
          category: "work",
        },
      ],
    };

    // search for the person
    const person = await this.copper.listObjects({
      $,
      objectType: "people",
      data: {
        emails: [
          this.email,
        ],
      },
    });

    if (!person?.length && !this.name) {
      throw new ConfigurationError(`Person with email ${this.email} not found. Name is required for creating a new person.`);
    }

    // create person if not found
    if (!person?.length) {
      response = await this.copper.createPerson({
        $,
        data,
      });
    }
    // update person if found
    else {
      response = await this.copper.updatePerson({
        $,
        personId: person[0].id,
        data,
      });
    }

    $.export("$summary", `Successfully ${person?.length
      ? "updated"
      : "created"} person with ID: ${response.id}`);
    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
Copper	`copper`	`app`	This component uses the Copper app.
Email	`email`	`string`	Email address of the person. If email already exists, the person will be updated
Name	`name`	`string`	Name of the contact. Required if creating a new person.
Street Address	`streetAddress`	`string`	Street address of the person
City	`city`	`string`	City address of the person
State	`state`	`string`	State address of the person
Postal Code	`postalCode`	`string`	Postal code of the person
Country	`country`	`string`	Country of the person
Phone	`phone`	`string`	Phone number of the person