Reply To Conversation with Intercom API on Project Item Status Changed from GitHub API

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

Trigger workflow on

Project Item Status Changed from the GitHub API

Next, do this

Reply To Conversation with the Intercom 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 GitHub trigger and Intercom action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Project Item Status Changed trigger
1. Connect your GitHub account
2. Select a Organization
3. Optional- Select a repo
4. Select a Project V2
5. Optional- Select one or more Item Status
6. Optional- Select one or more Filter Item Type
Configure the Reply To Conversation action
1. Connect your Intercom account
2. Select a Conversation ID
3. Select a Reply Type
4. Select a Message Type
5. Configure Body
6. Optional- Configure Attachment URLs
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#

Project Item Status Changed on GitHub

Description:Emit new event when a project item is tagged with a specific status. Currently supports Organization Projects only. [More information here](https://docs.github.com/en/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project)

Version:0.1.8

Key:github-new-issue-with-status

View on GitHub

GitHub Overview#

The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.

Trigger Code#

import queries from "../../common/queries.mjs";
import common from "../common/common-webhook-orgs.mjs";
import constants from "../common/constants.mjs";
import { getRelevantHeaders } from "../common/utils.mjs";

export default {
  ...common,
  key: "github-new-issue-with-status",
  name: "Project Item Status Changed",
  description: "Emit new event when a project item is tagged with a specific status. Currently supports Organization Projects only. [More information here](https://docs.github.com/en/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project)",
  version: "0.1.8",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    repo: {
      ...common.props.repo,
      label: common.props.repo.label,
      description: common.props.repo.description,
      optional: true,
    },
    project: {
      propDefinition: [
        common.props.github,
        "projectV2",
        (c) => ({
          org: c.org,
          repo: c?.repo,
        }),
      ],
    },
    status: {
      propDefinition: [
        common.props.github,
        "status",
        (c) => ({
          org: c.org,
          repo: c?.repo,
          project: c.project,
        }),
      ],
      optional: true,
    },
    itemType: {
      type: "string[]",
      label: "Filter Item Type",
      description: "The item type(s) to emit events or. If not specified, events will be emitted for all item types.",
      optional: true,
      options: constants.PROJECT_ITEM_TYPES,
    },
  },
  methods: {
    ...common.methods,
    getWebhookEvents() {
      return [
        "projects_v2_item",
      ];
    },
    generateMeta(item, statusName) {
      const { id } = item;
      const ts = Date.parse(item.updated_at);
      return {
        id: `${id}-${ts}`,
        summary: `Item #${id} to status "${statusName}"`,
        ts,
      };
    },
    isRelevant(event) {
      const fieldChanged = event.changes?.field_value?.field_name;
      if (fieldChanged !== "Status") {
        return;
      }

      let isRelevant = true;
      let message = "";

      const statusId = event.changes.field_value.to.id;
      const itemType = event.projects_v2_item.content_type;

      if (this.status?.length && !this.status.includes(statusId)) {
        const statusName = event.changes.field_value.to.name;
        message = `Status "${statusName}". Skipping...`;
        isRelevant = false;
      } else if (this.itemType?.length && !this.itemType.includes(itemType)) {
        message = `Item type "${itemType}". Skipping...`;
        isRelevant = false;
      }

      if (message) console.log(message);
      return isRelevant;
    },
    async getProjectItem({ nodeId }) {
      const { node } = await this.github.graphql(queries.projectItemQuery, {
        nodeId,
      });
      return node;
    },
    async processEvent({
      event, headers,
    }) {
      const item = event.projects_v2_item;

      if (!this.isRelevant(event)) {
        return;
      }

      console.log(`Emitting item #${item.id}`);

      const statusName = event.changes.field_value.to.name;
      const meta = this.generateMeta(item, statusName);
      this.$emit({
        ...event,
        ...getRelevantHeaders(headers),
      }, meta);
    },
  },
  async run({
    body: event, headers,
  }) {
    if (event.zen) {
      console.log(event.zen);
      return;
    }

    await this.processEvent({
      event,
      headers,
    });
  },
};

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
GitHub	`github`	`app`	This component uses the GitHub app.
Organization	`org`	`string`	Select a value from the drop down menu.
	`repo`	`string`	Select a value from the drop down menu.
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.
Project V2	`project`	`integer`	Select a value from the drop down menu.
Item Status	`status`	`string[]`	Select a value from the drop down menu.
Filter Item Type	`itemType`	`string[]`	Select a value from the drop down menu:`IssuePullRequestDraftIssue`

Trigger Authentication#

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

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

reporead:orgadmin:org_hookgistprojectnotificationsread:userwrite:discussionadmin:repo_hook

About GitHub#

Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.

Action#

Reply To Conversation on Intercom

Description:Add a reply or a note to an existing conversation thread. [See the documentation](https://developers.intercom.com/docs/references/rest-api/api.intercom.io/conversations/replyconversation).

Version:0.0.1

Key:intercom-reply-to-conversation

View on GitHub

Intercom Overview#

The Intercom API offers rich capabilities for enhancing customer communication and support workflows. By leveraging this API on Pipedream, you can automate tasks, sync customer data across platforms, and create personalized interactions. Whether you are managing user segments, sending targeted messages, or updating customer profiles, the Intercom API's robust set of endpoints allows for intricate and useful automations within your business processes.

Action Code#

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

export default {
  key: "intercom-reply-to-conversation",
  name: "Reply To Conversation",
  description: "Add a reply or a note to an existing conversation thread. [See the documentation](https://developers.intercom.com/docs/references/rest-api/api.intercom.io/conversations/replyconversation).",
  version: "0.0.1",
  type: "action",
  props: {
    intercom,
    conversationId: {
      propDefinition: [
        intercom,
        "conversationId",
      ],
    },
    replyType: {
      type: "string",
      label: "Reply Type",
      description: "The type of the reply.",
      options: [
        {
          label: "Contact Reply",
          value: "user",
        },
        {
          label: "Admin Reply",
          value: "admin",
        },
      ],
      reloadProps: true,
    },
    messageType: {
      propDefinition: [
        intercom,
        "messageType",
        ({ replyType: type }) => ({
          type,
        }),
      ],
    },
    body: {
      type: "string",
      label: "Body",
      description: "The text body of the comment.",
    },
    attachmentUrls: {
      type: "string[]",
      label: "Attachment URLs",
      description: "A list of image URLs that will be added as attachments. You can include up to 10 URLs.",
      optional: true,
    },
  },
  additionalProps() {
    const {
      replyType,
      replyOnBehalfOf,
    } = this;

    if (replyType === "admin") {
      return {
        adminId: {
          type: "string",
          label: "Admin ID",
          description: "The id of the admin who is authoring the comment.",
          options: async () => {
            const { admins } = await this.intercom.listAdmins();
            return admins.map((admin) => ({
              label: admin.name,
              value: admin.id,
            }));
          },
        },
      };
    }

    return {
      replyOnBehalfOf: {
        type: "string",
        label: "Reply On Behalf Of",
        description: "The user ID of the user on whose behalf the reply is being made.",
        options: [
          {
            label: "Intercom User ID",
            value: "intercom_user_id",
          },
          {
            label: "Email",
            value: "email",
          },
          {
            label: "User ID",
            value: "user_id",
          },
        ],
        reloadProps: true,
      },
      ...(replyOnBehalfOf === "intercom_user_id" && {
        intercomUserId: {
          type: "string",
          label: "Intercom User ID",
          description: "The identifier for the contact as given by Intercom.",
          options: async () => {
            const results = await this.intercom.searchContacts({
              query: {
                field: "role",
                operator: "=",
                value: "user",
              },
            });
            return results.map((user) => ({
              label: user.name || user.id,
              value: user.id,
            }));
          },
        },
      }),
      ...(replyOnBehalfOf === "email" && {
        email: {
          type: "string",
          label: "Email",
          description: "The email you have defined for the user.",
          options: async () => {
            const results = await this.intercom.searchContacts({
              query: {
                field: "role",
                operator: "=",
                value: "user",
              },
            });
            return results.map((user) => ({
              label: user.name || user.id,
              value: user.email,
            }));
          },
        },
      }),
      ...(replyOnBehalfOf === "user_id" && {
        userId: {
          type: "string",
          label: "User ID",
          description: "The external ID you have defined for the contact.",
          options: async () => {
            const results = await this.intercom.searchContacts({
              query: {
                field: "role",
                operator: "=",
                value: "user",
              },
            });
            return results.map((user) => ({
              label: user.name || user.id,
              value: user.external_id,
            }));
          },
        },
      }),
    };
  },
  methods: {
    replyToConversation({
      conversationId, ...args
    } = {}) {
      return this.intercom.makeRequest({
        method: "POST",
        endpoint: `conversations/${conversationId}/parts`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      replyToConversation,
      conversationId,
      body,
      attachmentUrls,
      replyType,
      adminId,
      intercomUserId,
      email,
      userId,
      messageType,
    } = this;

    const response = await replyToConversation({
      $,
      conversationId,
      data: {
        body,
        attachment_urls: attachmentUrls,
        admin_id: adminId,
        intercom_user_id: intercomUserId,
        email,
        user_id: userId,
        message_type: messageType,
        type: replyType,
      },
    });

    $.export("$summary", "Reply or note added successfully");
    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
Intercom	`intercom`	`app`	This component uses the Intercom app.
Conversation ID	`conversationId`	`string`	Select a value from the drop down menu.
Reply Type	`replyType`	`string`	Select a value from the drop down menu:`{ "label": "Contact Reply", "value": "user" }{ "label": "Admin Reply", "value": "admin" }`
Message Type	`messageType`	`string`	Select a value from the drop down menu.
Body	`body`	`string`	The text body of the comment.
Attachment URLs	`attachmentUrls`	`string[]`	A list of image URLs that will be added as attachments. You can include up to 10 URLs.

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

Reply To Conversation with Intercom API on Project Item Status Changed from GitHub API

Pipedream makes it easy to connect APIs for Intercom, GitHub 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