Create User Broadcast with Chatforma API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create User Broadcast with the Chatforma 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#

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

Configure the Create User Broadcast action
1. Connect your Chatforma account
2. Select a Bot ID
3. Select a Bot User ID
4. Configure Content
5. Optional- Configure Run At
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
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.

Create User Broadcast on Chatforma

Description:Sends a broadcast message to a specific user. [See the documentation](https://docs.chatforma.com/#/developers/post_bots__botId__dispatch_user__botUserId_)

Version:0.0.1

Key:chatforma-create-user-broadcast

View on GitHub

Code#

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

export default {
  key: "chatforma-create-user-broadcast",
  name: "Create User Broadcast",
  description: "Sends a broadcast message to a specific user. [See the documentation](https://docs.chatforma.com/#/developers/post_bots__botId__dispatch_user__botUserId_)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    chatforma,
    botId: {
      propDefinition: [
        chatforma,
        "botId",
      ],
    },
    botUserId: {
      propDefinition: [
        chatforma,
        "botUserId",
        ({ botId }) => ({
          botId,
        }),
      ],
    },
    content: {
      propDefinition: [
        chatforma,
        "content",
      ],
    },
    runAt: {
      type: "string",
      label: "Run At",
      description: "Date/Time to send message in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp format. Example: `2023-01-01T00:00:00.000Z`. Not providing a runAt will schedule the message for immediate delivery.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.chatforma.dispatchUserBroadcast({
      $,
      botId: this.botId,
      botUserId: this.botUserId,
      data: {
        content: this.content,
        run_at: this.runAt,
      },
    });

    $.export("$summary", `Successfully sent broadcast to user ${this.botUserId}`);
    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.

Label	Prop	Type	Description
Chatforma	`chatforma`	`app`	This component uses the Chatforma app.
Bot ID	`botId`	`string`	Select a value from the drop down menu.
Bot User ID	`botUserId`	`string`	Select a value from the drop down menu.
Content	`content`	`string`	The content of the message to broadcast
Run At	`runAt`	`string`	Date/Time to send message in ISO 8601 timestamp format. Example: `2023-01-01T00:00:00.000Z`. Not providing a runAt will schedule the message for immediate delivery.