Send Message with Zulip API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Send Message with the Zulip 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

Chase Roberts
@chsrbrts
@benedictevans If you haven’t used @pipedream yet, then you haven’t lived.
✨Ellie Day✨
@heyellieday
Evaluation update: @pipedream has quite literally been a dream to work with! I’m excited to leverage this tool for all the various workflows I need to write. I’m currently at 11k invocations a day from the initial workflows I’ve written in the past couple weeks.
Michael Braedley
@MBraedley
Update: I got it working properly, and it's working so well that I'm dropping IFTTT. @pipedream can do everything that IFTTT basic can, and most (if not all things) IFTTT pro can for free or at a reasonable price if you need it. I am recommending it for basically any power user.
Thomas Cutting
@mrthomascutting
Want quick+dirty integrations for a serverless workflow - @pipedream is my new go-to 😃
Matthew Roberts
@mattdotroberts
day 013 - finally hit node js. This is the secret sauce of taking #nocode projects that one step further. Pumped about getting deeper into @pipedream now
Kenneth Auchenberg 💭
@auchenberg
Yahoo Pipes is back! Kinda 😍 @pipedream
Raymond Camden 🥑
@raymondcamden
Awesome video by the @pipedream folks showing real time twitter sentiment analysis integrated with Google Sheets. This is where Pipedream *really* shines, connecting systems together in easy workflows.
Nacho Caballero
@nachocaballero
I couldn't recommend @pipedream more. It's an amazing service to integrate different APIs. Much more powerful than Zapier and more user-friendly than AWS Lambda. I'm very proud to wear this t-shirt #NoCode
Jason Snow
@jyksnw
Developed a working prototype environmental sensor IoT solution with @particle Photon, @pipedream, and @MongoDB with full graphing and alerting in less than a day! All amazing technology, will def. be exploring these more.
Steven Terrana
@steven_terrana
@burgwyn you've inspired me to finally set up my own blog. I'll make sure my first blog post explains the tech behind the setup. think @obsdmd + @GatsbyJS + @pipedream.
🚄 James Augeri, PhD
@DotDotJames
Want to low-code your back end, need more horsepower than @Bubble / @KnackHQ, or just miss Yahoo! Pipes? Check out @PipeDream
Sébastien Chopin
@Atinux
GitHub issues should be like @linear_app for maintainers. Looking forward more integrations with GH actions or tools like @pipedream 👀
Raul
@raul_predescu
If you're a dev and not using @pipedream, you're missing out. Been using it for months, daily. FREE for devs. Plenty of integrations and good limits. Absolutely love it.
Bruno Skvorc
@bitfalls
So @pipedream is pretty amazing. In 3 minutes I just made a flow which adds @rickastley's Never Gonna Give You Up to my @spotify playlist whenever a new pull request arrives in an old repo of mine.
Zach Lanich
@ZachLanich
Um, wow 🤯 @pipedream
Steven Bell
@bellontech
I just used @pipedream to build a Shopify App. Wow, they make small backed tasks easy.
Jay Hack 🎩🇺🇸
@_jayhack_
Very impressed with this bad boi - it reminds me of a @PalantirTech internal tool, but geared towards integrations instead of data analysis and far more customizable. Great expectations here 🚀🤩
Tree Sturgeon 🔥🚴‍♂️🌳
@philsturgeon
For context this is day 2 of a really challenging and stupid migration from Notion to @airtable with disparate/missing data. It's going better than expected and thanks to @pipedream I don't have to bother the iOS dev to add W3W.

Getting Started#

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

Configure the Send Message action
1. Connect your Zulip account
2. Select a Type
3. Optional- Select one or more User ID
4. Optional- Select a Channel ID
5. Optional- Select a Topic
6. Configure Content
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

Integrations#

Send Message with Zulip API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Zulip

Try it

Send Message with Zulip API on New Submission from Typeform API

Typeform + Zulip

Try it

Send Message with Zulip API on New Submission (Instant) from Jotform API

Jotform + Zulip

Try it

Send Message with Zulip API on New Scheduled Tasks from Pipedream API

Pipedream + Zulip

Try it

Send Message with Zulip API on New Download Counts from npm API

npm + Zulip

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.

Send Message on Zulip

Description:Send a direct or channel message. [See the documentation](https://zulip.com/api/send-message)

Version:0.0.1

Key:zulip-send-message

View on GitHub

Code#

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

export default {
  key: "zulip-send-message",
  name: "Send Message",
  description: "Send a direct or channel message. [See the documentation](https://zulip.com/api/send-message)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    type: {
      propDefinition: [
        app,
        "type",
      ],
    },
    userId: {
      propDefinition: [
        app,
        "userId",
      ],
    },
    channelId: {
      propDefinition: [
        app,
        "channelId",
      ],
    },
    topic: {
      propDefinition: [
        app,
        "topic",
        (c) => ({
          channelId: c.channelId,
        }),
      ],
    },
    content: {
      propDefinition: [
        app,
        "content",
      ],
    },
  },

  async run({ $ }) {
    const isDirect = this.type === "direct" || this.type === "private";
    const isChannel = this.type === "channel" || this.type === "stream";

    if (isDirect && (!this.userId || this.userId.length === 0)) {
      throw new ConfigurationError("You must provide at least one User ID when the type is 'direct' or 'private'.");
    }

    if (isChannel && !this.channelId) {
      throw new ConfigurationError("You must provide a Channel ID when the type is 'channel' or 'stream'.");
    }

    if ((isDirect && this.channelId) || (isChannel && this.userId?.length > 0)) {
      throw new ConfigurationError(`Invalid input: '${this.type}' messages require only ${isDirect
        ? "User ID(s)"
        : "a Channel ID"}.`);
    }
    const response = await this.app.sendMessage({
      $,
      params: {
        type: this.type,
        to: this.channelId || `[${this.userId.join(",")}]`,
        topic: this.topic,
        content: this.content,
      },
    });
    $.export("$summary", `Sucessfully sent message 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.

Label	Prop	Type	Description
Zulip	`app`	`app`	This component uses the Zulip app.
Type	`type`	`string`	Select a value from the drop down menu:`directchannelstreamprivate`
User ID	`userId`	`integer[]`	Select a value from the drop down menu.
Channel ID	`channelId`	`integer`	Select a value from the drop down menu.
Topic	`topic`	`string`	Select a value from the drop down menu.
Content	`content`	`string`	The content of the message

Authentication#

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

Zulip requires their users enter their Zulip email to connect to their API. For more info, refer to Zulip’s documentation.

To retrieve your API Key,