POST /accounts/{account_id}/queues/{queue_id}/messages/pull
Pull a batch of messages from a Queue
Servers
- https://api.cloudflare.com/client/v4
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. |
visibility_timeout_ms |
Number | No |
The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt. |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.