UPupstash
Messages

Get a Message

Changed on

Retrieve details of a specific message

get/v2/messages/{messageId}

Request

Path parameters

messageIdstring required

The identifier of the message to retrieve.

Response

Message details

messageIdstring

Unique identifier for the message

urlstring

The URL to which the message should be delivered.

topicNamestring

The URL Group (a.k.a. topic) name if this message was sent to a URL Group.

endpointNamestring

The endpoint name of the message if the endpoint is given a name within the URL group.

methodstring

The HTTP method to use for the message.

headerobject

The HTTP headers sent to your API.

bodystring

The body of the message if it is composed of utf8 chars only, empty otherwise.

bodyBase64string

The base64 encoded body if the body contains a non-utf8 char only, empty otherwise.

maxRetriesinteger

The number of retries that should be attempted in case of delivery failure.

notBeforeinteger

The unix timestamp in milliseconds before which the message should not be delivered.

createdAtinteger

The unix timestamp in milliseconds when the message was created.

callbackstring

The url where we send a callback each time the message is attempted to be delivered.

failureCallbackstring

The url where we send a callback to after the message is failed

queueNamestring

The name of the queue if the message is enqueued to a queue.

scheduleIdstring

The scheduleId of the message if the message is triggered by a schedule

callerIPstring

IP address of the publisher of this message.

labelstring

The label of the message assigned by the user. Deprecated in favor of labels.

labelsstring[]

The list of labels assigned to the message by the user.

flowControlKeystring

The flow control key used for rate limiting.

rateinteger

The rate value used for flow control.

periodinteger

The period value used for flow control.

parallelisminteger

The parallelism value used for flow control.

Changes

  • d30bd0904328Revision changes
    • info

      added the optional property to the response with the status

    • info

      response property label deprecated

  • d859c277ced2Revision changes
    • warning

      removed the optional property from the response with the status

    • info

      response property label reactivated