Cloudflare Queues · Example Payload

Cloudflare Queues Create Consumer

Example requests and responses for creating consumers for a Cloudflare Queue.

MessagingMessage QueueServerlessWorkersCloudflareAsyncDead Letter QueueEvent-Driven

Cloudflare Queues Create Consumer is an example object payload from Cloudflare Queues, with 3 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

titledescriptionexamples

Example Payload

Raw ↑
{
  "title": "Create Queue Consumer Examples",
  "description": "Example requests and responses for creating consumers for a Cloudflare Queue.",
  "examples": [
    {
      "title": "Worker Push Consumer",
      "description": "Create a Cloudflare Worker push consumer that automatically receives messages.",
      "request": {
        "method": "POST",
        "url": "https://api.cloudflare.com/client/v4/accounts/{account_id}/queues/{queue_id}/consumers",
        "headers": {
          "Authorization": "Bearer <api_token>",
          "Content-Type": "application/json"
        },
        "body": {
          "type": "worker",
          "script_name": "my-consumer-worker",
          "dead_letter_queue": "my-dead-letter-queue",
          "settings": {
            "batch_size": 25,
            "max_concurrency": 5,
            "max_retries": 3,
            "max_wait_time_ms": 5000,
            "retry_delay": 10
          }
        }
      },
      "response": {
        "status": 200,
        "body": {
          "success": true,
          "errors": [],
          "messages": [],
          "result": {
            "consumer_id": "023e105f4ecef8ad9ca31a8372d0c353",
            "type": "worker",
            "script_name": "my-consumer-worker",
            "queue_name": "my-message-queue",
            "dead_letter_queue": "my-dead-letter-queue",
            "created_on": "2024-01-15T10:00:00Z",
            "settings": {
              "batch_size": 25,
              "max_concurrency": 5,
              "max_retries": 3,
              "max_wait_time_ms": 5000,
              "retry_delay": 10
            }
          }
        }
      }
    },
    {
      "title": "HTTP Pull Consumer",
      "description": "Create an HTTP pull consumer that allows polling for messages via REST API.",
      "request": {
        "method": "POST",
        "url": "https://api.cloudflare.com/client/v4/accounts/{account_id}/queues/{queue_id}/consumers",
        "headers": {
          "Authorization": "Bearer <api_token>",
          "Content-Type": "application/json"
        },
        "body": {
          "type": "http_pull",
          "dead_letter_queue": "my-dead-letter-queue",
          "settings": {
            "batch_size": 50,
            "max_retries": 3,
            "retry_delay": 10,
            "visibility_timeout_ms": 30000
          }
        }
      },
      "response": {
        "status": 200,
        "body": {
          "success": true,
          "errors": [],
          "messages": [],
          "result": {
            "consumer_id": "abc123def456abc123def456abc12345",
            "type": "http_pull",
            "queue_name": "my-message-queue",
            "dead_letter_queue": "my-dead-letter-queue",
            "created_on": "2024-01-15T10:00:00Z",
            "settings": {
              "batch_size": 50,
              "max_retries": 3,
              "retry_delay": 10,
              "visibility_timeout_ms": 30000
            }
          }
        }
      }
    }
  ]
}

Work with this as data

Every example here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for examples

4 MCP tools reach this
  • find_examplesBrowse and filter every example in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This example
curl "https://apis.io/api/v1/examples/cloudflare-queues-create-consumer"
All examples
curl "https://apis.io/api/v1/examples?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.