Enqueue a Message

Enqueue a message to the specified queue

1 min read

post/v2/enqueue/{queueName}/{destination}

Request example

curl --request POST \
  --url https://qstash-eu-central-1.upstash.io/v2/enqueue/%3Cstring%3E/%3Cstring%3E \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <string>' \
  --header 'Upstash-Forward-*: <string>' \
  --header 'Upstash-Method: POST' \
  --header 'Upstash-Timeout: 5s' \
  --header 'Upstash-Retries: 1' \
  --header 'Upstash-Retry-Delay: <string>' \
  --header 'Upstash-Label: <string>' \
  --header 'Upstash-Deduplication-Id: <string>' \
  --header 'Upstash-Content-Based-Deduplication: false' \
  --header 'Upstash-Callback: <string>' \
  --header 'Upstash-Callback-Forward-*: <string>' \
  --header 'Upstash-Callback-*: <string>' \
  --header 'Upstash-Failure-Callback: <string>' \
  --header 'Upstash-Failure-Callback-Forward-*: <string>' \
  --header 'Upstash-Failure-Callback-*: <string>' \
  --header 'Upstash-Redact-Fields: <string>' \
  --header 'Content-Type: application/json' \
  --data '{}'

Response

{
  "messageId": "<string>",
  "deduplicated": true
}

post/v2/enqueue/{queueName}/{destination}

Authorization

Authorizationstringheaderrequired#

QStash authentication token

1 alternative authorization method available — see the spec for details.

Path parameters

queueNamestringrequired#

The name of the queue to enqueue the message to.

destinationstringrequired#

Destination can either be a valid URL where the message gets sent to, or a URL Group name.

If the destination is a URL, make sure the URL is prefixed with a valid protocol (http:// or https://)
If the destination is a URL Group, a new message will be created for each endpoint in the group.

Note that destination must be publicly accessible over the internet. If you are working with local endpoints, consider using QStash local development server or a public tunnel service.

Headers

Content-Typestring#

Content-Type is the MIME type of the message.

We highly recommend sending a Content-Type header along, as this will help your destination API to understand the content of the message.

Set this to whatever data you are sending through QStash, if your message is json, then use application/json. Some frameworks like Next.js will not parse your body correctly if the content type is not correct.

Examples:

application/json
application/xml
application/octet-stream
text/plain

Upstash-Forward-*string#

You can send custom headers to your endpoint along with your message.

To send a custom header, prefix the header name with Upstash-Forward-. We will strip prefix and send them to the destination.

Header	Forwarded To Destination As
Upstash-Forward-My-Header: my-value	My-Header: my-value
Upstash-Forward-Authorization: Bearer <token>	Authorization: Bearer <token>

Upstash-Methodenum<string>#

The HTTP method to use when sending the request to your API.

Default: "POST"

Options:GETPOSTPUTPATCHDELETE

Upstash-Timeoutstring#

Specifies the maximum duration the request is allowed to take before timing out.

This parameter can be used to shorten the default allowed timeout value on your plan. See Max HTTP Connection Timeout on the pricing page for default values.

The format of this header is <value><unit> where value is a number and unit is one of:

s for seconds
m for minutes
h for hours.

Upstash-Retriesinteger#

How many times should this message be retried in case the destination API returns an error or is not available.

The total number of deliveries is 1 (initial attempt) + retries.

If it is not provided, the default of 3 retries is used.

Upstash-Retry-Delaystring#

Customize the delay between retry attempts when message delivery fails.

By default, QStash uses exponential backoff. You can override this by providing a mathematical expressions to compute next delay. This expression is computed after each failed attempt.

You can use the special variable retried, which is how many times the message has been retried. The retried is 0 for the first retry.

Supported functions:

Function	Description
`pow(x, y)`	Returns x raised to the power of y
`exp(x)`	Returns e raised to the power of x
`sqrt(x)`	Takes the square root of x
`abs(x)`	Returns the absolute value of x
`floor(x)`	Returns the largest integer less than or equal to x
`ceil(x)`	Returns the smallest integer greater than or equal to x
`round(x)`	Rounds x to the nearest integer
`min(x, y)`	Returns the smaller of x and y
`max(x, y)`	Returns the larger of x and y

Examples:

1000: Fixed 1 second delay
1000 * (1 + retried): Linear backoff
pow(2, retried) * 1000: Exponential backoff
max(1000, pow(2, retried) * 100): Exponential with minimum 1s delay

Upstash-Labelstring#

Label(s) to assign to the message for easier identification and filtering in logs and DLQ.

You can assign multiple labels by providing a comma-separated list.

Example: label_1,label_2

Upstash-Deduplication-Idstring#

Deduplication ID to use for de-duplicating messages.

If a message with the same deduplication ID was published in the last 10 minutes, the new message will be ignored.

Upstash-Content-Based-Deduplicationenum<string>#

Enable content based deduplication.

When enabled, QStash will compute a hash of the message body and use it as deduplication ID.
If a message with the same content was published in the last 10 minutes, the new message will be ignored.

Default: "false"

Options:truefalse

Upstash-Callbackstring#

You can define a callback url that will be called after message delivery, either success or failure. See the content of what will be delivered to a callback here.

Callback URL must be prefixed with a valid protocol (http:// or https://)
Callbacks are charged as a regular message.
Callbacks will use the retry setting from the original request.

Upstash-Callback-Forward-*string#

You can send custom headers along with your callback message.
To send a custom header, prefix the header name with Upstash-Callback-Forward-. We will strip prefix and them to the callback URL.

Header	Forwarded To Callback Destination As
Upstash-Callback-Forward-My-Header: my-value	My-Header: my-value
Upstash-Callback-Forward-Authorization: Bearer <token>	Authorization: Bearer <token>

Upstash-Callback-*string#

You can customize the callback message configuration.

See the Configuring Callbacks section to learn more.

Header	Description
Upstash-Callback-Method	HTTP method to use for the callback request. Default is POST.
Upstash-Callback-Timeout	Timeout for the callback request. Format is same as Upstash-Timeout header.
Upstash-Callback-Retries	Number of retries for the callback request. Default is same as original message retries.
Upstash-Callback-Retry-Delay	Retry delay for the callback request. Format is same as Upstash-Retry-Delay header.

Upstash-Failure-Callbackstring#

You can define a failure callback url that will be called when a delivery is failed. That is when all the defined retries are exhausted. See the content of what will be delivered to a failure callback here

Failure callback URL must be prefixed with a valid protocol (http:// or https://)
Failure callbacks are charged as a regular message.
Failure callbacks will use the retry setting from the original request.

Upstash-Failure-Callback-Forward-*string#

You can send custom headers along with your failure callback message.
To send a custom header, prefix the header name with Upstash-Failure-Callback-Forward-. We will strip prefix and them to the failure callback URL.

Header	Forwarded To Callback Destination As
Upstash-Failure-Callback-Forward-My-Header: my-value	My-Header: my-value
Upstash-Failure-Callback-Forward-Authorization: Bearer <token>	Authorization: Bearer <token>

Upstash-Failure-Callback-*string#

You can customize the failure callback message configuration.

See the Configuring Callbacks section to learn more.

Header	Description
Upstash-Failure-Callback-Method	HTTP method to use for the callback request. Default is POST.
Upstash-Failure-Callback-Timeout	Timeout for the callback request. Format is same as Upstash-Timeout header.
Upstash-Failure-Callback-Retries	Number of retries for the callback request. Default is same as original message retries.
Upstash-Failure-Callback-Retry-Delay	Retry delay for the callback request. Format is same as Upstash-Retry-Delay header.

Upstash-Redact-Fieldsstring#

Comma-separated list of fields to redact from the message. Redacted fields appear as REDACTED:<SHA256> in the dashboard and API responses. The original values are still used when delivering messages to your endpoint.

Available options:

Option	Description
`body`	Redact the body of the message
`headers`	Redact all headers of the message
`header[header_name]`	Redact a specific header (e.g., `header[Authorization]`)

Examples:

body: Redact only the body
body, header[Authorization]: Redact the body and the Authorization header
body, headers: Redact both body and all headers

Body

application/json · text/plain · application/octet-stream

bodyobject#

The raw request message passed to the endpoints as is

Responses

application/json

Message(s) enqueued successfully

One of

messageIdstring#

Unique identifier for the published message or the old message ID if deduplicated

deduplicatedboolean#

Whether this message is a duplicate and was not sent to the destination.

Publish a Message Batch Messages