Skip to content
Console
On this page

Get a broadcast

Gets a broadcast.

Gets a broadcast.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/broadcasts/broadcast
  • Scope notify:read
  • Effect read — nothing is written.
  • Collection broadcasts

Request

FieldTypeWhat it is
namestringThe name of the broadcast to get. Required.

Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/broadcasts/{broadcast}.
uidstringbct_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specBroadcastSpecDesired state. Required.
statusBroadcastStatusObserved state. Output only.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

BroadcastSpec

FieldTypeWhat it is
topicstringThe topic every message carries. Required.
templatestringThe template to render. Required.
segment_filterstringAIP-160 filter over recipient labels and fields selecting the segment. Required.
datastructTemplate variables shared by every message.
send_timetimestampWhen to send; unset sends only on :send.

BroadcastStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready, Reconciling, Stalled. Output only.
stateBroadcastStateThe broadcast's progress. Output only. One of draft, scheduled, sending, sent, cancelled.
schedulestringThe Workflows Schedule that fires it. Output only.
admitted_countint64Messages admitted. Output only.
skipped_countint64Recipients skipped by suppression or preference. Output only.

Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

Errors

Every error arrives in the body Errors describes.

Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/broadcasts/broadcast" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"