Publish - Upstash Documentation

Publish to a URL with a 3 second delay and headers/body

import { Client } from "@upstash/qstash";

const client = new Client({ token: "<QSTASH_TOKEN>" });
const res = await client.publishJSON({
  url: "https://my-api...",
  body: { hello: "world" },
  headers: { "test-header": "test-value" },
  delay: "3s",
});

Publish to a URL group with a 3 second delay and headers/body

You create URL group on the QStash console or using the URL Group API

import { Client } from "@upstash/qstash";

const client = new Client({ token: "<QSTASH_TOKEN>" });
const res = await client.publishJSON({
  urlGroup: "my-url-group",
  body: { hello: "world" },
  headers: { "test-header": "test-value" },
  delay: "3s",
});

// When publishing to a URL Group, the response is an array of messages for each URL in the URL Group
console.log(res[0].messageId);

Publish a method with a callback URL

Callbacks are useful for long running functions. Here, QStash will return the response of the publish request to the callback URL. We also change the method to GET in this use case so QStash will make a GET request to the url. The default is POST.

import { Client } from "@upstash/qstash";

const client = new Client({ token: "<QSTASH_TOKEN>" });
const res = await client.publishJSON({
  url: "https://my-api...",
  body: { hello: "world" },
  callback: "https://my-callback...",
  failureCallback: "https://my-failure-callback...",
  method: "GET",
});

Configure the number of retries

The max number of retries is based on your QStash plan

import { Client } from "@upstash/qstash";

const client = new Client({ token: "<QSTASH_TOKEN>" });
const res = await client.publishJSON({
  url: "https://my-api...",
  body: { hello: "world" },
  retries: 1,
});

By default, the delay between retries is calculated using an exponential backoff algorithm. You can customize this using the retry_delay parameter. Check out the retries documentation to learn more about custom retry delay values.

Publish HTML content instead of JSON

import { Client } from "@upstash/qstash";

const client = new Client({ token: "<QSTASH_TOKEN>" });
const res = await client.publish({
  url: "https://my-api...",
  body: "<html><body><h1>Hello World</h1></body></html>",
  headers: {
    "Content-Type": "text/html",
  },
});

Publish a message with content-based-deduplication

import { Client } from "@upstash/qstash";

const client = new Client({ token: "<QSTASH_TOKEN>" });
const res = await client.publishJSON({
  url: "https://my-api...",
  body: { hello: "world" },
  contentBasedDeduplication: true,
});

Publish a message with timeout

Timeout value in seconds to use when calling a url (See Upstash-Timeout in Publish Message page)

import { Client } from "@upstash/qstash";

const client = new Client({ token: "<QSTASH_TOKEN>" });
const res = await client.publishJSON({
  url: "https://my-api...",
  body: { hello: "world" },
  timeout: "30s" // 30 seconds timeout
});

Publish a message with labels

Labels let you tag a message so you can later identify and filter it in the logs or when cancelling messages.

import { Client } from "@upstash/qstash";

const client = new Client({ token: "<QSTASH_TOKEN>" });

// attach a single label
await client.publishJSON({
  url: "https://my-api...",
  body: { hello: "world" },
  label: "my-label",
});

// attach multiple labels to the same message
await client.publishJSON({
  url: "https://my-api...",
  body: { hello: "world" },
  label: ["team-a", "high-priority"],
});

Labels are also available when batching and when enqueuing to a queue.

​Publish to a URL with a 3 second delay and headers/body

​Publish to a URL group with a 3 second delay and headers/body

​Publish a method with a callback URL

​Configure the number of retries

​Publish HTML content instead of JSON

​Publish a message with content-based-deduplication

​Publish a message with timeout

​Publish a message with labels