POST /accounts/{account_id}/queues/{queue_id}/messages/preview

Preview messages from a Queue without leasing them. Messages remain available for subsequent preview or pull operations.

Servers

Path parameters

Name Type Required Description
queue_id String Yes
account_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
batch_size Number No

The maximum number of messages to include in a batch.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.