Skip to main content
Create a queue

Authorizations

Authorization
string
header
required

LithoBlocks API key obtained from your organization dashboard. The LithoBlocks MCP server also presents a Supabase-issued user session token here on the user's behalf; such a token acts as that user with the scopes their organization role allows.

Body

application/json

The queue

name
string
required
Required string length: 1 - 255
template_id
string<uuid>
required
execution_mode
enum<string>
required
Available options:
fixed_interval,
rolling_window,
fixed_volume
execution_config
object
required

Canonical keys per execution_mode: fixed_interval → { interval_minutes }; rolling_window → { window_minutes }; fixed_volume → { event_threshold, max_wait_minutes }

destination
object
required
description
string
Maximum string length: 2000
aggregation_config
object

How the batch's events become one template data; omitted, the template receives { items: [event, …] }

credit_cost
integer
default:1
Required range: 1 <= x <= 100
is_active
boolean
default:true
follow_live
boolean

true sends whatever version of the template is live when each batch sends. Omitted or false, the queue is pinned to the version live now, as it always has been

Response

Created

id
string
required
name
string
required
description
string | null
required
template_id
string
required
template_version_id
string | null
required

The version every batch sends. null sends whatever version is live when the batch sends (follow_live)

execution_mode
enum<string>
required
Available options:
fixed_interval,
rolling_window,
fixed_volume
execution_config
object
required

Canonical keys per execution_mode: fixed_interval → { interval_minutes }; rolling_window → { window_minutes }; fixed_volume → { event_threshold, max_wait_minutes }

destination
object
required
aggregation_config
object | null
required
credit_cost
integer
required
is_active
boolean
required
created_at
string
required
updated_at
string
required
pending_event_count
integer

Events waiting in the open batch

active_batch
object | null