Skip to main content
POST
Create

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orgId
string
required

The organization's id (UUID) or slug — either form is accepted.

projectId
string
required

The project's id (UUID) or slug — either form is accepted.

Query Parameters

environment
string

Environment slug to scope this operation to. Defaults to "production". An environment that does not exist on the project answers 404. The queue is created in the addressed environment.

Pattern: ^[a-z][a-z0-9-]{0,38}$

Body

application/json
name
string
required
Pattern: ^[a-z][a-z0-9-]{1,61}$
consumer
object
required

Signed push consumer. A delivery invokes this project-relative HTTPS path with one message envelope or { messages: [...] } for a logical batch. Deliveries are at least once; a successful 2xx response acknowledges every message in that request.

retentionSeconds
integer

Retention from 60 seconds through 14 days. Defaults to four days.

deliveryDelaySeconds
integer

Default delay from 0 through 86400 seconds.

deadLetterQueueId
string | null

Response

Queue provisioning started.

id
string
required
name
string
required
Pattern: ^[a-z][a-z0-9-]{1,61}$
environment
string
required
status
enum<string>
required
Available options:
provisioning,
ready,
paused,
failed
retentionSeconds
integer
required

Message retention. Configurable up to 14 days.

deliveryDelaySeconds
integer
required

Default delivery delay, at most 86400 seconds.

deadLetterQueueId
string | null
required
consumer
object
required

Signed push consumer. A delivery invokes this project-relative HTTPS path with one message envelope or { messages: [...] } for a logical batch. Deliveries are at least once; a successful 2xx response acknowledges every message in that request.

deliveryGuarantee
enum<string>
required
Available options:
at-least-once
orderingGuarantee
enum<string>
required
Available options:
none
createdAt
string<date-time>
required
updatedAt
string<date-time>
required