Menu
Platform
AI
Alerts and status pages
App store purchases
Credits
Generated Assets
Knowledge
KV
Localization
Notifications
Organizations
Payments
Queues
Realtime
Sandboxes
Storage
Workflows
API reference
- Overview
- Access API keys
- Agent sessions API
- Agent versions API
- Agents API
- AI models API
- Artifact references API
- Artifacts API
- Assets API
- Auth configs API
- Bank receipts API
- Bank transfer accounts API
- Buckets API
- Builds API
- Catalogs API
- Chat profiles API
- Chat reports API
- Chat sticker packs API
- Checkout policies API
- Checkout sessions API
- Config changes API
- Config flags API
- Config segments API
- Connection providers API
- Connections API
- Connectors API
- Credit grants API
- Customer organizations API
- Customer subscriptions API
- Databases API
- Documents API
- Email domains API
- End users API
- Entities API
- Entitlement grants API
- Entries API
- Environments API
- Episodes API
- Error events API
- Error groups API
- Events API
- Exchange rates API
- Generations API
- Glossaries API
- Goals API
- Identities API
- Inbound emails API
- Inbound endpoints API
- Inbound messages API
- Inbound sms API
- Invitations API
- Job runs API
- Jobs API
- Knowledge schemas API
- KV API
- KV namespaces API
- Lease events API
- Leases API
- Licence keys API
- Licence tokens API
- Mail domains API
- Mail routes API
- Mailbox connect links API
- Mailbox OAUTH apps API
- Mailboxes API
- Memberships API
- Memories API
- Memory stores API
- Merchant accounts API
- Message topics API
- Messages API
- OAUTH clients API
- Objects API
- Organization roles API
- Orgs API
- Owner pools API
- Phone numbers API
- Portal sessions API
- Preferences API
- Price catalogs API
- Processor events API
- Projects API
- Queued executions API
- Queues API
- Realtime channels API
- Realtime members API
- Realtime messages API
- Recipients API
- Relations API
- Releases API
- Revenue API
- Revenue facts API
- Revenue sources API
- Runs API
- Sandbox shapes API
- Schedules API
- Scrubbing policies API
- Search API
- Search indexes API
- Secret versions API
- Secrets API
- Service enablements API
- Service observations API
- Services API
- Serving routes API
- Session events API
- Sessions API
- Signing key versions
- Signing keys
- Sms numbers API
- Source maps API
- Spaces API
- Store connections API
- Store purchases API
- Subscriptions API
- Suppressions API
- Tax threshold statuses API
- Templates API
- Test clocks API
- Token exchanges API
- Transfers API
- Trust policies API
- Trusted issuers API
- Uptime checks API
- Uptime manifests API
- Uptime sources API
- Usage events API
- Usage invoices API
- Usage meter prices API
- Usage meters API
- Usage reservations API
- Usage settings API
- Usage tiers API
- Volumes API
- Waits API
- Webhook deliveries API
- Webhook endpoints API
- Workflows API
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Queues
What a queue is, how a message moves through it, and where to go next.
A Queue holds messages until a worker has finished with them. Producers send messages; workers lease them, do the work, and ack each one. A message that is not acked comes back, and a message that keeps failing moves to a dead-letter set you can replay once the bug is fixed. Queues are part of Sylphx Events: there is nothing to deploy, one key in your project is enough, and your workers run wherever they already run.
#How a message moves
- Send. A message is a CloudEvent:
id,source,typeand adatapayload. Up to 100 go in one call, anddelayhides them for a while before the first lease. - Lease. A worker leases up to 100 messages at a time. A leased message is
hidden from every other worker for the queue's
visibility_timeout(30 seconds by default, up to 12 hours). Withwait, a lease on an empty queue waits up to 20 seconds for a message instead of answering empty at once. - Ack or nack. An ack removes the message for good. A nack returns it at
once, or after a
delayyou set. A lease that runs out without either also returns the message, and counts as a delivery. - Dead-letter. After
max_deliveriesdeliveries (5 by default, up to 100) the message leaves the ready set: into the queue's own dead-letter set, or into another queue named bydead_letter_queue. - Replay.
replayreturns dead-lettered messages to ready, all of them or those dead-lettered in a time range, with a fresh delivery count.
#Leases are fenced
Every lease carries a lease_generation. When a lease runs out and another
worker takes the message, the first worker's lease is stale: its ack or nack
is not applied and comes back in stale_leases. A slow worker can therefore
never ack away a message another worker is still processing. Delivery is at
least once, so make the work idempotent on the message id.
#Routing events into a queue
A Subscription sends the environment's events whose
type and source match into a queue, so a worker can consume events without
the producer naming the queue.
#Names and ids
- Queue
- orgs/{org}/projects/{project}/envs/{env}/queues/{queue}
- Queue id
- que_<cell><ulid>
- Message id
- Returned by send; the same on every delivery
#The scopes
events:publish— sending messages.events:write— creating, changing and deleting a queue, and leasing, acking, nacking and replaying its messages.events:read— reading queues and their counts.
Keys and scopes covers creating a key with these scopes.