On this page
Send a queue
Enqueues messages directly, without a Subscription.
Enqueues messages directly, without a Subscription.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue:send - Scope
events:publish - Effect
write— a successful call changes state. - Collection queues
Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the queue. Required. |
events | CloudEvent[] | The messages, at most 100. Required. |
delay | duration | Hide the messages this long before their first lease. |
CloudEvent
| Field | Type | What it is |
|---|---|---|
id | string | Unique per source; with source it is the dedupe key. Required. |
source | string | The producer's URI-reference. Required. |
type | string | The event type, for example com.example.order.created. Required. |
subject | string | The subject within the source. |
event_time | timestamp | When the occurrence happened. |
data_content_type | string | The payload media type; default application/json. |
data_schema | string | The payload schema URI. |
data | value | The payload. |
extensions | map<string, string> | Extension attributes, at most 64. |
Response
| Field | Type | What it is |
|---|---|---|
message_ids | string[] | The message ids, in request order. |
Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.INVALID_FIELD— A field failed validation.RATE_LIMITED— The rate limit is reached; see Retry-After.SPEND_LIMIT_REACHED— The org's spend limit is reached.
Every error arrives in the body Errors describes.
Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue:send" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"events":[{"id":"…","source":"…","type":"…"}]}'