← Intercom

Upsert Contact with Intercom API

Pipedream makes it easy to connect APIs for Intercom and 2,200+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Upsert Contact with the Intercom API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Upsert Contact with the Intercom API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Upsert Contact action
    1. Connect your Intercom account
    2. Configure Email
    3. Optional- Select a Role
    4. Optional- Configure External Id
    5. Optional- Configure Phone
    6. Optional- Configure Name
    7. Optional- Configure Avatar
    8. Optional- Configure Unsubscribed From Emails
    9. Optional- Configure Custom Attributes
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Upsert Contact with Intercom API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Intercom
 
Try it
Upsert Contact with Intercom API on New Submission from Typeform API
Typeform + Intercom
 
Try it
Upsert Contact with Intercom API on New Submission (Instant) from Jotform API
Jotform + Intercom
 
Try it
Upsert Contact with Intercom API on New Scheduled Tasks from Pipedream API
Pipedream + Intercom
 
Try it
Upsert Contact with Intercom API on New Download Counts from npm API
npm + Intercom
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Upsert Contact on Intercom
Description:Create a new contact. If there is already a contact with the email provided, the existing contact will be updated. [See the docs here](https://developers.intercom.com/docs/references/rest-api/api.intercom.io/contacts/createcontact)
Version:0.0.1
Key:intercom-upsert-contact

Code

import { ROLE_OPTIONS } from "../../common/constants.mjs";
import intercom from "../../intercom.app.mjs";

export default {
  key: "intercom-upsert-contact",
  name: "Upsert Contact",
  description: "Create a new contact. If there is already a contact with the email provided, the existing contact will be updated. [See the docs here](https://developers.intercom.com/docs/references/rest-api/api.intercom.io/contacts/createcontact)",
  version: "0.0.1",
  type: "action",
  props: {
    intercom,
    email: {
      type: "string",
      label: "Email",
      description: "The contact's email.",
    },
    role: {
      type: "string",
      label: "Role",
      description: "The role of the contact.",
      options: ROLE_OPTIONS,
      optional: true,
    },
    externalId: {
      type: "string",
      label: "External Id",
      description: "A unique identifier for the contact which is given to Intercom.",
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "The contact's phone number.",
      optional: true,
    },
    name: {
      type: "string",
      label: "Name",
      description: "The contact's name.",
      optional: true,
    },
    avatar: {
      type: "string",
      label: "Avatar",
      description: "An image URL containing the avatar of a contact.",
      optional: true,
    },
    unsubscribedFromEmails: {
      type: "boolean",
      label: "Unsubscribed From Emails",
      description: "Whether the contact is unsubscribed from emails.",
      optional: true,
    },
    customAttributes: {
      type: "object",
      label: "Custom Attributes",
      description: "The custom attributes which are set for the contact.",
      optional: true,
    },
  },
  async run({ $ }) {
    let response = {};
    let requestType = "created";
    let data = {
      email: this.email,
      role: this.role,
      externalId: this.externalId,
      phone: this.phone,
      name: this.name,
      avatar: this.avatar,
      unsubscribedFromEmails: this.unsubscribedFromEmails,
      customAttributes: this.customAttributes,
    };

    data = Object.entries(data).filter(([
      ,
      value,
    ]) => (value != "" && value != undefined))
      .reduce((obj, [
        key,
        value,
      ]) => Object.assign(obj, {
        [key]: value,
      }), {});

    const {
      data: contact, total_count: total,
    } = await this.intercom.searchContact({
      data: {
        query: {
          operator: "AND",
          value: [
            {
              field: "email",
              operator: "=",
              value: this.email,
            },
          ],
        },
        pagination: {
          per_page: 1,
        },
      },
    });

    if (total) {
      const {
        id: contactId,
        // eslint-disable-next-line no-unused-vars
        owner_id,
        ...contactInfos
      } = contact[0];
      response = await this.intercom.updateContact({
        $,
        contactId,
        data: {
          ...contactInfos,
          ...data,
        },
      });
      requestType = "updated";
    } else {
      response = await this.intercom.createContact({
        $,
        data,
      });
    }
    $.export("$summary", `Successfully ${requestType} contact with ID ${response.id}`);
    return response;
  },
};

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.
LabelPropTypeDescription
IntercomintercomappThis component uses the Intercom app.
Emailemailstring

The contact's email.

RolerolestringSelect a value from the drop down menu:{ "label": "User", "value": "user" }{ "label": "Lead", "value": "lead" }
External IdexternalIdstring

A unique identifier for the contact which is given to Intercom.

Phonephonestring

The contact's phone number.

Namenamestring

The contact's name.

Avataravatarstring

An image URL containing the avatar of a contact.

Unsubscribed From EmailsunsubscribedFromEmailsboolean

Whether the contact is unsubscribed from emails.

Custom AttributescustomAttributesobject

The custom attributes which are set for the contact.

Authentication

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

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

About Intercom

Intercom is the only solution that combines an AI chatbot, help desk, and proactive support—so you can keep costs low, support teams happy, and customers satisfied.

More Ways to Use Intercom

Triggers

New Companies from the Intercom API

Emit new event each time a new company is added.

 
Try it
New Reply From Admin from the Intercom API

Emit new event each time an admin replies to a conversation.

 
Try it
New Conversations from the Intercom API

Emit new event each time a new conversation is added.

 
Try it
New Reply From User from the Intercom API

Emit new event each time a user replies to a conversation.

 
Try it
New Unsubscriptions from the Intercom API

Emit new event each time a user unsubscribes from receiving emails.

 
Try it

Actions

Create Note with the Intercom API

Creates a note for a specific user. See the docs here

 
Try it
Send Incoming Message with the Intercom API

Send a message from a user into your Intercom app. See the docs here

 
Try it

Explore Other Apps

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

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.