Create Message
Publish a message
Request
Destination can either be a topic name or id that you configured in the
Upstash console, or a valid url where the message gets sent to. Make sure the
url is prefixed with a valid protocol (http:// or https://)
The raw request message passed to the endpoints as is
ContentType 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.
For example application/json, application/xml, application/octet-stream,
text/plain
The HTTP method to use when sending a webhook to your API.
Delay the message delivery.
Format for this header is a number followed by duration abbreviation, like
10s. Available durations are s (seconds), m (minutes), h (hours), d
(days).
example: ”50s” | “3m” | “10h” | “1d”
How often should this messasge be retried in case the destination API is not available.
The total number of deliveries is therefore capped at 1 + retries
Leave this empty to use the default value, (free tier: 3, paid tier: 5)
The backoff duration in seconds is calculated as follows: n is the number of
times the task has been retried.
min(86400, e ** (2 * n))
You can define a callback url that will be called after each attempt. See the content of what will be delivered to a callback here
- The callback url must be prefixed with a valid protocol (
http://orhttps://) - Callbacks are charged as a regular message.
- Callbacks will use the retry setting from the original request.
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
- The failure callback url must be prefixed with a valid protocol (
http://orhttps://) - Callbacks are charged as a regular message.
- Callbacks will use the retry setting from the original request.
You can send custom headers along with your message.
To send a custom header, prefix the header name with Upstash-Forward-. We will
strip efix and them to the destination API.
example: “Upstash-Forward-My-Header: my-value” -> “My-Header: my-value”
Response
Either a single object or an array of objects is returned, depending on whether you have sent the message to a url or topic
The unique id of this message.
The url where the message was sent to.
Whether this message is a duplicate and was not sent to the destination.
Was this page helpful?