Menu
Platform
AI
Analytics
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Queues
Realtime
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
sylphx notify broadcasts
Every sylphx notify broadcasts command: its argument, its flags and a run line.
This method is not served on the public API.
api.sylphx.comdoes not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.
The broadcasts commands of Sylphx Notify, as the CLI spells them: the same
calls as the broadcasts API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#get
Gets a broadcast.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx notify broadcasts get orgs/acme/projects/shop/envs/production/broadcasts/broadcastGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/broadcasts/broadcast · scope notify:read · effect read · Request, response and examples
#list
Lists broadcasts.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx notify broadcasts list orgs/acme/projects/shop/envs/productionGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/broadcasts · scope notify:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | At most this many; default 50, clamped to 1000. |
--page-token | string | next_page_token of the previous page. |
--filter | string | AIP-160 filter over labels and filterable fields. |
--order-by | string | AIP-132 ordering over filterable fields. |
#create
Creates a broadcast.
ID — The id segment of the new Resource's name; the server assigns one when omitted.
CLI
sylphx notify broadcasts create --parent orgs/acme/projects/shop/envs/production --spec.topic … --spec.template … --spec.segment-filter …POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/broadcasts · scope notify:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--parent | string | The parent to create in; defaults to the linked project or the key's scope. |
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--spec.topic | string | The topic every message carries. Required. |
--spec.template | string | The template to render. Required. |
--spec.segment-filter | string | AIP-160 filter over recipient labels and fields selecting the segment. Required. |
--spec.data | json | Template variables shared by every message. |
--spec.send-time | timestamp | When to send; unset sends only on :send. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#update
Updates a broadcast.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx notify broadcasts update orgs/acme/projects/shop/envs/production/broadcasts/broadcast --spec.topic … --spec.template … --spec.segment-filter …PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/broadcasts/broadcast · scope notify:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--spec.topic | string | The topic every message carries. Required. |
--spec.template | string | The template to render. Required. |
--spec.segment-filter | string | AIP-160 filter over recipient labels and fields selecting the segment. Required. |
--spec.data | json | Template variables shared by every message. |
--spec.send-time | timestamp | When to send; unset sends only on :send. |
--allow-missing | bool | Create the broadcast when it does not exist (declarative upsert). |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#delete
Deletes a broadcast.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx notify broadcasts delete orgs/acme/projects/shop/envs/production/broadcasts/broadcast --yesDELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/broadcasts/broadcast · scope notify:write · effect destructive · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--etag | string | Delete only if the current etag matches. |
--allow-missing | bool | Succeed when the broadcast does not exist. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--yes | bool | Do not ask before this destructive call. |
#send
Sends a Broadcast now.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx notify broadcasts send orgs/acme/projects/shop/envs/production/broadcasts/broadcastPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/broadcasts/broadcast:send · scope notify:send · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--etag | string | Act only if the current etag matches. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#cancel
Cancels a Broadcast; messages already admitted still deliver.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx notify broadcasts cancel orgs/acme/projects/shop/envs/production/broadcasts/broadcast --yesPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/broadcasts/broadcast:cancel · scope notify:send · effect destructive · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--etag | string | Act only if the current etag matches. |
--yes | bool | Do not ask before this destructive call. |