Send message with Sendbird API on New Chat from HelpCrunch API

Pipedream makes it easy to connect APIs for Sendbird, HelpCrunch and 2,000+ other apps remarkably fast.

Trigger workflow on

New Chat from the HelpCrunch API

Next, do this

Send message with the Sendbird API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a HelpCrunch trigger and Sendbird action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Chat trigger
1. Connect your HelpCrunch account
2. Configure timer
Configure the Send message action
1. Connect your Sendbird account
2. Configure Application Id
3. Select a Channel Type
4. Select a Channel URL
5. Select a User Id
6. Optional- Configure Send Push
7. Optional- Select a Mention Type
8. Optional- Select one or more Mentioned User Ids
9. Optional- Configure Is Silent
10. Optional- Configure Dedup Id
11. Select a Message Type
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 Chat on HelpCrunch

Description:Emit new event when a new chat is created. [See the documentation](https://docs.helpcrunch.com/en/rest-api-v1/search-chats-v1)

Version:0.0.1

Key:helpcrunch-new-chat

View on GitHub

HelpCrunch Overview#

The HelpCrunch API provides a platform for customer communication, enabling automation of messaging, data synchronization, and customer support activities. It allows you to create and update users, send messages, and manage conversations directly through API calls. Integrating HelpCrunch with Pipedream lets you connect these capabilities to hundreds of other apps, streamlining workflows that can respond dynamically to customer interactions, sync data across platforms, or trigger communications based on specific events.

Trigger Code#

import base from "../common/base.mjs";

export default {
  ...base,
  key: "helpcrunch-new-chat",
  name: "New Chat",
  description: "Emit new event when a new chat is created. [See the documentation](https://docs.helpcrunch.com/en/rest-api-v1/search-chats-v1)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...base.methods,
    getResourceFn() {
      return this.helpcrunch.searchChats;
    },
    getKey() {
      return "createdAt";
    },
    generateMeta(chat) {
      return {
        id: chat.id,
        summary: `New Chat with ID ${chat.id}`,
        ts: chat.createdAt,
      };
    },
  },
};

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
HelpCrunch	`helpcrunch`	`app`	This component uses the HelpCrunch app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

About HelpCrunch #

One-stop platform to build strong customer relationships

Action#

Send message on Sendbird

Description:Sends a message to a channel. [See the docs here](https://sendbird.com/docs/chat/v3/platform-api/message/messaging-basics/send-a-message)

Version:0.0.1

Key:sendbird-send-message

View on GitHub

Sendbird Overview#

The Sendbird API provides programmatic access to advanced chat features, enabling the creation and management of in-app messaging for community forums, customer support, or any other chat-based interaction. By leveraging the Sendbird API on Pipedream, you can automate user management, message and channel handling, and event tracking. Pipedream's serverless platform simplifies these automations, offering a way to integrate chat functionalities with other services, trigger workflows from chat events, and handle real-time data processing without writing extensive infrastructure code.

Action Code#

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

export default {
  key: "sendbird-send-message",
  name: "Send message",
  description: "Sends a message to a channel. [See the docs here](https://sendbird.com/docs/chat/v3/platform-api/message/messaging-basics/send-a-message)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    applicationId: {
      propDefinition: [
        app,
        "applicationId",
      ],
    },
    channelType: {
      propDefinition: [
        app,
        "channelType",
      ],
    },
    channelUrl: {
      propDefinition: [
        app,
        "channelUrl",
        (c) => ({
          applicationId: c.applicationId,
          channelType: c.channelType,
        }),
      ],
    },
    userId: {
      propDefinition: [
        app,
        "userId",
        (c) => ({
          applicationId: c.applicationId,
        }),
      ],
    },
    sendPush: {
      propDefinition: [
        app,
        "sendPush",
      ],
    },
    mentionType: {
      propDefinition: [
        app,
        "mentionType",
      ],
    },
    mentionedUserIds: {
      propDefinition: [
        app,
        "mentionedUserIds",
        (c) => ({
          applicationId: c.applicationId,
        }),
      ],
    },
    isSilent: {
      propDefinition: [
        app,
        "isSilent",
      ],
    },
    dedupId: {
      propDefinition: [
        app,
        "dedupId",
      ],
    },
    messageType: {
      propDefinition: [
        app,
        "messageType",
      ],
      description: "Specifies the type of the message.",
      optional: false,
      reloadProps: true,
    },
  },
  async additionalProps() {
    if (!this.messageType) {
      return {};
    }
    if (this.messageType === "FILE") {
      return {
        url: {
          type: "string",
          label: "URL",
          description: "Specifies the URL of the file hosted on the server of your own or other third-party companies.",
        },
        fileName: {
          type: "string",
          label: "File Name",
          description: "The file name can be set to any string you want using the file name request property. If no file name is supplied, the name response property defaults to an empty string.",
          optional: true,
        },
      };
    }
    return {
      message: {
        type: "string",
        label: "Message",
        description: "Specifies the content of the message.",
      },
    };
  },
  async run({ $ }) {
    const opts = {
      message: this.message,
      url: this.url,
      file_name: this.fileName,
      user_id: this.userId,
      message_type: this.messageType,
      send_push: this.sendPush,
      mention_type: this.mentionType,
      mentioned_user_ids: this.mentionedUserIds,
      is_silent: this.isSilent,
      dedup_id: this.dedupId,
    };
    try {
      const message = await this.app.sendMessage(
        this.applicationId,
        this.channelType,
        this.channelUrl,
        opts,
      );
      $.export("$summary", `Successfully sent message with ID: ${message.message_id}`);
      return message;
    } catch (ex) {
      throw new ConfigurationError(ex?.body?.message);
    }
  },
};

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
Sendbird	`app`	`app`	This component uses the Sendbird app.
Application Id	`applicationId`	`string`	Specifies the unique ID of the Application. To find the application ID, sign in to Sendbird Dashboard, go to Settings > Application > General, and then check Application ID.
Channel Type	`channelType`	`string`	Select a value from the drop down menu:`{ "label": "Open Channels", "value": "open_channels" }{ "label": "Group Channels", "value": "group_channels" }`
Channel URL	`channelUrl`	`string`	Select a value from the drop down menu.
User Id	`userId`	`string`	Select a value from the drop down menu.
Send Push	`sendPush`	`boolean`	Determines whether to send a push notification for the message to the members of the channel (applicable to group channels only). Unlike text and file messages, a push notification for an admin message is not sent by default. (Default: true)
Mention Type	`mentionType`	`string`	Select a value from the drop down menu:`{ "label": "Users", "value": "users" }{ "label": "Channel", "value": "channel" }`
Mentioned User Ids	`mentionedUserIds`	`string[]`	Select a value from the drop down menu.
Is Silent	`isSilent`	`boolean`	Determines whether to send a message without updating some of the channel properties. If a message is sent in a channel, with this property set to true, the channel's last_message is updated only for the sender while its unread_message_count remains unchanged for all channel members.
Dedup Id	`dedupId`	`string`	Specifies the unique message ID created by other system. In general, this property is used to prevent the same message data from getting inserted when migrating the messages of the other system to Sendbird server. If specified, the server performs a duplicate check using the property value.
Message Type	`messageType`	`string`	Select a value from the drop down menu:`{ "label": "Message", "value": "MESG" }{ "label": "File", "value": "FILE" }{ "label": "Admin Message", "value": "ADMM" }`

Action Authentication#

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

To connect Sendbird, you will need to provide two keys.

In your organization's settings, please locate and copy your Organization API Key located in Settings the top-right corner under API Key.
Please navigate to the app that you have created, under "Applications" >> "Settings" >> "API Tokens", please copy your Master API Token.

Learn more at Sendbird API documentation