Publish Endpoint Message with QStash API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Publish Endpoint Message with the QStash 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 Publish Endpoint Message with the QStash API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Publish Endpoint Message action
1. Connect your QStash account
2. Configure Callback Endpoint
3. Configure Body
4. Optional- Configure Retries
5. Optional- Configure Deduplication ID
6. Optional- Configure Content Based Deduplication Enabled
7. Optional- Configure Delay
8. Optional- Configure Cron
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#

Publish Endpoint Message with QStash API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + QStash

Try it

Publish Endpoint Message with QStash API on New Item in Feed from RSS API

RSS + QStash

Try it

Publish Endpoint Message with QStash API on New Message in Channel from Discord Bot API

Discord Bot + QStash

Try it

Publish Endpoint Message with QStash API on New Submission from Typeform API

Typeform + QStash

Try it

Publish Endpoint Message with QStash API on Custom Events from Zoom API

Zoom + QStash

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.

Publish Endpoint Message on QStash

Description:Publish a message a callback endpoint

Version:0.0.1

Key:qstash-publish-endpoint-message

View on GitHub

Code#

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

export default {
  name: "Publish Endpoint Message",
  version: "0.0.1",
  key: "qstash-publish-endpoint-message",
  description: "Publish a message a callback endpoint",
  type: "action",
  props: {
    qstash,
    endpoint: {
      propDefinition: [
        qstash,
        "endpoint",
      ],
    },
    body: {
      propDefinition: [
        qstash,
        "body",
      ],
    },
    retries: {
      propDefinition: [
        qstash,
        "retries",
      ],
    },
    deduplicationId: {
      propDefinition: [
        qstash,
        "deduplicationId",
      ],
    },
    contentBasedDeduplicationEnabled: {
      propDefinition: [
        qstash,
        "contentBasedDeduplicationEnabled",
      ],
    },
    delay: {
      propDefinition: [
        qstash,
        "delay",
      ],
    },
    cron: {
      propDefinition: [
        qstash,
        "cron",
      ],
    },
  },
  async run({ $ }) {
    const {
      body, endpoint, deduplicationId, retries, cron, delay, contentBasedDeduplicationEnabled,
    } = this;

    return this.qstash.publishEndpointMessage({
      $,
      body,
      endpoint,
      deduplicationId,
      contentBasedDeduplicationEnabled,
      retries,
      cron,
      delay,
    });
  },
};

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
QStash	`qstash`	`app`	This component uses the QStash app.
Callback Endpoint	`endpoint`	`string`	The endpoint that will be receiving these events
Body	`body`	`object`	The body is forwarded to your endpoints in the HTTP request
Retries	`retries`	`integer`	How often should this messasge be retried in case the destination API is not available.
Deduplication ID	`deduplicationId`	`string`	Provide an ID that will be used to detect duplicate messages. If a duplicate message is detected, the request will be accepted but not enqueued. Learn more.
Content Based Deduplication Enabled	`contentBasedDeduplicationEnabled`	`boolean`	If true, the message content will get hashed and used as deduplication ID. If a duplicate message is detected, the request will be accepted but not enqueued.
Delay	`delay`	`string`	Format for this header is a number followed by duration abbreviation, like `10s`. Available durations are `s` (seconds), `m` (minutes), `h` (hours), `d` (days).
Cron	`cron`	`string`	You can use a tool like Crontab.guru to generate cron expressions.

Authentication#

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