Skip to main content
POST
Send a live activity update

Authorizations

Authorization
string
header
required

An API key from the dashboard. The scopes listed on each operation are the resource:action grants a key needs (messages:send, subscribers:read, topics:*, *); account:* scopes and key management are session-only. Workspace keys (bk_ws_) reach every tenant and pick one with the buzzkit-tenant header; tenant keys (bk_tn_) are locked to one tenant; client keys (bk_pk_) ship inside an app and only work on /v1/client/*.

Body

to
string
required
Required string length: 1 - 256
event
enum<string>
required
Available options:
start,
update,
end
contentState
object
required
activityId
string
Required string length: 1 - 128
attributesType
string
Required string length: 1 - 128
attributes
object
alert
object
staleDate
string
Maximum string length: 40
dismissalDate
string
Maximum string length: 40
priority
enum<string>
Available options:
high,
normal
timestamp
integer
Required range: x >= 0

Response

Response for status 200

success
boolean
required
data
object | null
required
error
object | null
required
metadata
object
required