Pipedream has joined Workday
Learn more
ExploreConnectDocsChangelogPricingTemplatesString
Sign in
Sign up
← Intercom

Manage A Conversation with Intercom API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Manage A Conversation 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 Manage A Conversation with the Intercom API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Manage A Conversation action
    1. Connect your Intercom account
    2. Select a Conversation ID
    3. Select a Message Type
    4. Select a Type
    5. Select a Admin ID
    6. Select a Assignee ID
    7. Select a Assignee ID
    8. Optional- Configure Body
    9. Optional- Configure Snoozed Until
  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

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.

Manage A Conversation on Intercom
Description:Close/Snooze/Open/Assign a conversation by its ID. [See the documentation](https://developers.intercom.com/docs/references/2.12/rest-api/api.intercom.io/conversations/manageconversation).
Version:0.0.1
Key:intercom-manage-conversation

Code

import {
  MESSAGE_TYPE_OPTIONS,
  TYPE_OPTIONS,
} from "../../common/constants.mjs";
import intercom from "../../intercom.app.mjs";

export default {
  key: "intercom-manage-conversation",
  name: "Manage A Conversation",
  description: "Close/Snooze/Open/Assign a conversation by its ID. [See the documentation](https://developers.intercom.com/docs/references/2.12/rest-api/api.intercom.io/conversations/manageconversation).",
  version: "0.0.1",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    intercom,
    conversationId: {
      propDefinition: [
        intercom,
        "conversationId",
      ],
    },
    messageType: {
      type: "string",
      label: "Message Type",
      description: "The kind of message being created.",
      reloadProps: true,
      options: MESSAGE_TYPE_OPTIONS,
    },
    type: {
      type: "string",
      label: "Type",
      description: "The type of the message being created.",
      options: TYPE_OPTIONS,
      reloadProps: true,
      hidden: true,
    },
    adminId: {
      propDefinition: [
        intercom,
        "adminId",
      ],
    },
    assigneeId: {
      propDefinition: [
        intercom,
        "adminId",
      ],
      label: "Assignee ID",
      description: "The `id` of the `admin` which will be assigned the conversation. A conversation can be assigned both an admin and a team.\nSet `0` if you want this assign to no admin (ie. Unassigned).",
      hidden: true,
    },
    teamAssigneeId: {
      propDefinition: [
        intercom,
        "teamAssigneeId",
      ],
      hidden: true,
    },
    body: {
      type: "string",
      label: "Body",
      description: "The text body of the comment.",
      hidden: true,
      optional: true,
    },
    snoozedUntil: {
      type: "string",
      label: "Snoozed Until",
      description: "The date and time the conversation will be snoozed until. Format: YYYY-MM-DDTHH:MM:SSZ",
      hidden: true,
      optional: true,
    },
  },
  additionalProps(props) {
    props.type.hidden = true;
    props.body.hidden = true;
    props.snoozedUntil.hidden = true;
    props.assigneeId.hidden = true;

    switch (this.messageType) {
    case "snoozed":
      props.snoozedUntil.hidden = false;
      break;
    case "close":
      props.body.hidden = false;
      break;
    case "assignment":
      props.type.hidden = false;
      props.body.hidden = false;
      props.assigneeId.hidden = false;

      if (this.type === "team") {
        props.teamAssigneeId.hidden = false;
        props.assigneeId.hidden = true;
      } else if (this.type === "admin") {
        props.teamAssigneeId.hidden = true;
        props.assigneeId.hidden = false;
      }
      break;
    }
    return {};
  },
  methods: {
    manageConversation({
      conversationId, ...args
    } = {}) {
      return this.intercom.makeRequest({
        method: "POST",
        endpoint: `conversations/${conversationId}/parts`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      manageConversation,
      conversationId,
      body,
      type,
      adminId,
      messageType,
      snoozedUntil,
      assigneeId,
    } = this;

    const response = await manageConversation({
      $,
      conversationId,
      data: {
        body,
        admin_id: adminId,
        message_type: messageType,
        type: messageType === "close"
          ? "admin"
          : type,
        snoozed_until: snoozedUntil && Date.parse(snoozedUntil) / 1000,
        assignee_id: assigneeId,
      },
    });

    $.export("$summary", "Conversation managed successfully");
    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.
Conversation IDconversationIdstringSelect a value from the drop down menu.
Message TypemessageTypestringSelect a value from the drop down menu:{ "label": "Close", "value": "close" }{ "label": "Snooze", "value": "snoozed" }{ "label": "Open", "value": "open" }{ "label": "Assign", "value": "assignment" }
Admin IDadminIdstringSelect a value from the drop down menu.

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

Add Tag To Contact with the Intercom API

Adds a specific tag to a contact in Intercom. See the documentation

 
Try it
Create Note with the Intercom API

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

 
Try it
Reply To Conversation with the Intercom API

Add a reply or a note to an existing conversation thread. See the documentation

 
Try it
Retrieve A Conversation with the Intercom API

Retrieve a conversation by its ID. See the documentation

 
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
3,000+
apps by most popular

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.
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.
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.
Anthropic (Claude)
Anthropic (Claude)
AI research and products that put safety at the frontier. Introducing Claude, a next-generation AI assistant for your tasks, no matter the scale.
Google Sheets
Google Sheets
Use Google Sheets to create and edit online spreadsheets. Get insights together with secure sharing in real-time and from any device.
Telegram
Telegram
Telegram, is a cloud-based, cross-platform, encrypted instant messaging (IM) service.
Google Drive
Google Drive
Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.
HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Google Calendar
Google Calendar
With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
Pipedream Utils
Pipedream Utils
Utility functions to use within your Pipedream workflows
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.
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.
AWS
AWS
Premium
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Twilio SendGrid
Twilio SendGrid
Premium
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
Klaviyo
Klaviyo
Premium
Klaviyo unifies your data, channels, and AI agents in one platform—text, WhatsApp, email marketing, and more—driving growth with every interaction.
Zendesk
Zendesk
Premium
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
ServiceNow
ServiceNow
Premium
Beta
The smarter way to workflow
Slack
Slack
Slack is the AI-powered platform for work bringing all of your conversations, apps, and customers together in one place. Around the world, Slack is helping businesses of all sizes grow and send productivity through the roof.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
abcdefghijklmnopqrstuvwxyz#
Pipedream, Inc. — San Francisco, CA
AboutTwitterDocsCommunityTermsPrivacyCookie SettingsTry String