API Examples - Upstash Documentation

Use QStash via:

Below are some examples to get you started. You can also check the how to section for more technical details or the API reference to test the API.

Publish a message to an endpoint

Simple example to publish a message to an endpoint.

curl -XPOST \
    -H 'Authorization: Bearer XXX' \
    -H "Content-type: application/json" \
    -d '{ "hello": "world" }' \
    'https://qstash.upstash.io/v2/publish/https://example.com'

curl -XPOST \
    -H 'Authorization: Bearer XXX' \
    -H "Content-type: application/json" \
    -d '{ "hello": "world" }' \
    'https://qstash.upstash.io/v2/publish/https://example.com'

const client = new Client({ token: "<QSTASH_TOKEN>" });
await client.publishJSON({
  url: "https://example.com",
  body: {
    hello: "world",
  },
});

client = Client("<QSTASH_TOKEN>")
client.publish_json({
  "url": "https://example.com",
  "body": {
    "hello": "world",
  },
})
# Async version is also available

Publish a message to a topic

The topic is a way to publish a message to multiple endpoints in a fan out pattern.

curl -XPOST \
    -H 'Authorization: Bearer XXX' \
    -H "Content-type: application/json" \
    -d '{ "hello": "world" }' \
    'https://qstash.upstash.io/v2/publish/myTopic'

curl -XPOST \
    -H 'Authorization: Bearer XXX' \
    -H "Content-type: application/json" \
    -d '{ "hello": "world" }' \
    'https://qstash.upstash.io/v2/publish/myTopic'

const client = new Client({ token: "<QSTASH_TOKEN>" });
await client.publishJSON({
  topic: "myTopic",
  body: {
    hello: "world",
  },
});

client = Client("<QSTASH_TOKEN>")
client.publish_json({
  "topic": "myTopic",
  "body": {
    "hello": "world",
  },
})
# Async version is also available

Publish a message with 5 minutes delay

Add a delay to the message to be published. After QStash receives the message, it will wait for the specified time (5 minutes in this example) before sending the message to the endpoint.

curl -XPOST \
    -H 'Authorization: Bearer XXX' \
    -H "Content-type: application/json" \
    -H "Upstash-Delay: 5m" \
    -d '{ "hello": "world" }' \
    'https://qstash.upstash.io/v2/publish/https://example.com'

curl -XPOST \
    -H 'Authorization: Bearer XXX' \
    -H "Content-type: application/json" \
    -H "Upstash-Delay: 5m" \
    -d '{ "hello": "world" }' \
    'https://qstash.upstash.io/v2/publish/https://example.com'

const client = new Client({ token: "<QSTASH_TOKEN>" });
await client.publishJSON({
  url: "https://example.com",
  body: {
    hello: "world",
  },
  delay: 300,
});

client = Client("<QSTASH_TOKEN>")
client.publish_json({
  "url": "https://example.com",
  "body": {
    "hello": "world",
  },
  "delay": 300,
})
# Async version is also available

Send a custom header

Add a custom header to the message to be published.

curl -XPOST \
    -H 'Authorization: Bearer XXX' \
    -H 'Upstash-Forward-My-Header: my-value' \
    -H "Content-type: application/json" \
    -d '{ "hello": "world" }' \
    'https://qstash.upstash.io/v2/publish/https://example.com'

curl -XPOST \
    -H 'Authorization: Bearer XXX' \
    -H 'Upstash-Forward-My-Header: my-value' \
    -H "Content-type: application/json" \
    -d '{ "hello": "world" }' \
    'https://qstash.upstash.io/v2/publish/https://example.com'

const client = new Client({ token: "<QSTASH_TOKEN>" });
await client.publishJSON({
  url: "https://example.com",
  body: {
    hello: "world",
  },
  headers: {
    "My-Header": "my-value",
  },
});

client = Client("<QSTASH_TOKEN>")
client.publish_json({
  "url": "https://example.com",
  "body": {
    "hello": "world",
  },
  "headers": {
    "My-Header": "my-value",
  },
})
# Async version is also available

Schedule to run once a day

curl -XPOST \
    -H 'Authorization: Bearer XXX' \
    -H "Upstash-Cron: 0 0 * * *" \
    -H "Content-type: application/json" \
    -d '{ "hello": "world" }' \
    'https://qstash.upstash.io/v2/schedules/https://example.com'

curl -XPOST \
    -H 'Authorization: Bearer XXX' \
    -H "Upstash-Cron: 0 0 * * *" \
    -H "Content-type: application/json" \
    -d '{ "hello": "world" }' \
    'https://qstash.upstash.io/v2/schedules/https://example.com'

const client = new Client({ token: "<QSTASH_TOKEN>" });
const schedules = client.schedules();
await schedules.create({
  destination: "https://example.com",
  cron: "0 0 * * *",
});

client = Client("<QSTASH_TOKEN>")
schedules = client.schedules()
schedules.create({
  "destination": "https://example.com",
  "cron": "0 0 * * *",
})
# Async version is also available

Set max retry count to 3

Configure how many times QStash should retry to send the message to the endpoint before sending it to the dead letter queue.

curl -XPOST \
    -H 'Authorization: Bearer XXX' \
    -H "Upstash-Retries: 3" \
    -H "Content-type: application/json" \
    -d '{ "hello": "world" }' \
    'https://qstash.upstash.io/v2/publish/https://example.com'

curl -XPOST \
    -H 'Authorization: Bearer XXX' \
    -H "Upstash-Retries: 3" \
    -H "Content-type: application/json" \
    -d '{ "hello": "world" }' \
    'https://qstash.upstash.io/v2/publish/https://example.com'

const client = new Client({ token: "<QSTASH_TOKEN>" });
await client.publishJSON({
  url: "https://example.com",
  body: {
    hello: "world",
  },
  retries: 3,
});

client = Client("<QSTASH_TOKEN>")
client.publish_json({
  "url": "https://example.com",
  "body": {
    "hello": "world",
  },
  "retries": 3,
})
# Async version is also available

Set callback url

Receive a response from the endpoint and send it to the specified callback URL. If the endpoint returns a response, QStash will send it to the failure callback URL.

curl -XPOST \
    -H 'Authorization: Bearer XXX' \
    -H "Content-type: application/json" \
    -H "Upstash-Callback: https://example.com/callback" \
    -H "Upstash-Failure-Callback: https://example.com/failure" \
    -d '{ "hello": "world" }' \
    'https://qstash.upstash.io/v2/publish/https://example.com'

curl -XPOST \
    -H 'Authorization: Bearer XXX' \
    -H "Content-type: application/json" \
    -H "Upstash-Callback: https://example.com/callback" \
    -H "Upstash-Failure-Callback: https://example.com/failure" \
    -d '{ "hello": "world" }' \
    'https://qstash.upstash.io/v2/publish/https://example.com'

const client = new Client({ token: "<QSTASH_TOKEN>" });
await client.publishJSON({
  url: "https://example.com",
  body: {
    hello: "world",
  },
  callback: "https://example.com/callback",
  failureCallback: "https://example.com/failure",
});

client = Client("<QSTASH_TOKEN>")
client.publish_json({
  "url": "https://example.com",
  "body": {
    "hello": "world",
  },
  "callback": "https://example.com/callback",
  "failure_callback": "https://example.com/failure",
})
# Async version is also available

List all events

Retrieve a list of all events that have been published.

curl https://qstash.upstash.io/v2/events \
    -H "Authorization: Bearer <token>"

curl https://qstash.upstash.io/v2/events \
    -H "Authorization: Bearer <token>"

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

client = Client("<QSTASH_TOKEN>")
events = client.events()
# Async version is also available

List all schedules

curl https://qstash.upstash.io/v2/schedules \
    -H "Authorization: Bearer <token>"

curl https://qstash.upstash.io/v2/schedules \
    -H "Authorization: Bearer <token>"

const client = new Client({ token: "<QSTASH_TOKEN>" });
const schedules = client.schedules();
const scheds = await schedules.list();

client = Client("<QSTASH_TOKEN>")
schedules = client.schedules()
scheds = schedules.list()
# Async version is also available

​Use QStash via:

​Publish a message to an endpoint

​Publish a message to a topic

​Publish a message with 5 minutes delay

​Send a custom header

​Schedule to run once a day

​Set max retry count to 3

​Set callback url

​List all events

​List all schedules