v1

latestOpenAPI 3.1.0Apache 2.02026-07-17143043.7 KB
Querator V1

Produce an item on a queue

Produce an item on a queue. Calls to the endpoint may provide multiple items to produce. The call will not return until all items provided have been written to storage.

Timeout Semantics

The call will return when the item(s) provided are written to storage or when request_timeout has been reached. If the call returns with a non 200 response code, the client should consider the items provided as not written to the queue. The client should NOT cancel the request before request_timeout has been reached. If the call fails to return after request_timeout is reached the client can safely cancel the request.

post/v1/queue.produce

Request body

queue_namestring required

The name of the queue

request_timeoutstring required

The duration this request should block before the client will cancel the request

Example request

{
  "queue_name": "queue1",
  "request_timeout": "5m",
  "items": [
    {
      "encoding": "application/json",
      "kind": "webhook-v2",
      "reference": "john.smith",
      "bytes": "eyJrZXkiOiJ2YWx1ZSJ9",
      "utf8": "Hello World!"
    }
  ]
}

Response

codeinteger required

The response code

code_textstring

The text explanation of the code

messagestring

The message that contains details explaining the reason for the code

All 14 operations