Send a live activity update
curl --request POST \
--url https://api.buzzkit.dev/v1/live-activities/send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"to": "<string>",
"contentState": {},
"activityId": "<string>",
"attributesType": "<string>",
"attributes": {},
"alert": {
"title": "<string>",
"body": "<string>",
"sound": "<string>"
},
"staleDate": "<string>",
"dismissalDate": "<string>",
"timestamp": 1
}
'import requests
url = "https://api.buzzkit.dev/v1/live-activities/send"
payload = {
"to": "<string>",
"contentState": {},
"activityId": "<string>",
"attributesType": "<string>",
"attributes": {},
"alert": {
"title": "<string>",
"body": "<string>",
"sound": "<string>"
},
"staleDate": "<string>",
"dismissalDate": "<string>",
"timestamp": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
to: '<string>',
contentState: {},
activityId: '<string>',
attributesType: '<string>',
attributes: {},
alert: {title: '<string>', body: JSON.stringify('<string>'), sound: '<string>'},
staleDate: '<string>',
dismissalDate: '<string>',
timestamp: 1
})
};
fetch('https://api.buzzkit.dev/v1/live-activities/send', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.buzzkit.dev/v1/live-activities/send",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'to' => '<string>',
'contentState' => [
],
'activityId' => '<string>',
'attributesType' => '<string>',
'attributes' => [
],
'alert' => [
'title' => '<string>',
'body' => '<string>',
'sound' => '<string>'
],
'staleDate' => '<string>',
'dismissalDate' => '<string>',
'timestamp' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.buzzkit.dev/v1/live-activities/send"
payload := strings.NewReader("{\n \"to\": \"<string>\",\n \"contentState\": {},\n \"activityId\": \"<string>\",\n \"attributesType\": \"<string>\",\n \"attributes\": {},\n \"alert\": {\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"sound\": \"<string>\"\n },\n \"staleDate\": \"<string>\",\n \"dismissalDate\": \"<string>\",\n \"timestamp\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.buzzkit.dev/v1/live-activities/send")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to\": \"<string>\",\n \"contentState\": {},\n \"activityId\": \"<string>\",\n \"attributesType\": \"<string>\",\n \"attributes\": {},\n \"alert\": {\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"sound\": \"<string>\"\n },\n \"staleDate\": \"<string>\",\n \"dismissalDate\": \"<string>\",\n \"timestamp\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.buzzkit.dev/v1/live-activities/send")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to\": \"<string>\",\n \"contentState\": {},\n \"activityId\": \"<string>\",\n \"attributesType\": \"<string>\",\n \"attributes\": {},\n \"alert\": {\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"sound\": \"<string>\"\n },\n \"staleDate\": \"<string>\",\n \"dismissalDate\": \"<string>\",\n \"timestamp\": 1\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {},
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"details": {}
},
"metadata": {
"timestamp": "<string>",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}Live Activities
Send a live activity update
POST
/
v1
/
live-activities
/
send
Send a live activity update
curl --request POST \
--url https://api.buzzkit.dev/v1/live-activities/send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"to": "<string>",
"contentState": {},
"activityId": "<string>",
"attributesType": "<string>",
"attributes": {},
"alert": {
"title": "<string>",
"body": "<string>",
"sound": "<string>"
},
"staleDate": "<string>",
"dismissalDate": "<string>",
"timestamp": 1
}
'import requests
url = "https://api.buzzkit.dev/v1/live-activities/send"
payload = {
"to": "<string>",
"contentState": {},
"activityId": "<string>",
"attributesType": "<string>",
"attributes": {},
"alert": {
"title": "<string>",
"body": "<string>",
"sound": "<string>"
},
"staleDate": "<string>",
"dismissalDate": "<string>",
"timestamp": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
to: '<string>',
contentState: {},
activityId: '<string>',
attributesType: '<string>',
attributes: {},
alert: {title: '<string>', body: JSON.stringify('<string>'), sound: '<string>'},
staleDate: '<string>',
dismissalDate: '<string>',
timestamp: 1
})
};
fetch('https://api.buzzkit.dev/v1/live-activities/send', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.buzzkit.dev/v1/live-activities/send",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'to' => '<string>',
'contentState' => [
],
'activityId' => '<string>',
'attributesType' => '<string>',
'attributes' => [
],
'alert' => [
'title' => '<string>',
'body' => '<string>',
'sound' => '<string>'
],
'staleDate' => '<string>',
'dismissalDate' => '<string>',
'timestamp' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.buzzkit.dev/v1/live-activities/send"
payload := strings.NewReader("{\n \"to\": \"<string>\",\n \"contentState\": {},\n \"activityId\": \"<string>\",\n \"attributesType\": \"<string>\",\n \"attributes\": {},\n \"alert\": {\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"sound\": \"<string>\"\n },\n \"staleDate\": \"<string>\",\n \"dismissalDate\": \"<string>\",\n \"timestamp\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.buzzkit.dev/v1/live-activities/send")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to\": \"<string>\",\n \"contentState\": {},\n \"activityId\": \"<string>\",\n \"attributesType\": \"<string>\",\n \"attributes\": {},\n \"alert\": {\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"sound\": \"<string>\"\n },\n \"staleDate\": \"<string>\",\n \"dismissalDate\": \"<string>\",\n \"timestamp\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.buzzkit.dev/v1/live-activities/send")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to\": \"<string>\",\n \"contentState\": {},\n \"activityId\": \"<string>\",\n \"attributesType\": \"<string>\",\n \"attributes\": {},\n \"alert\": {\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"sound\": \"<string>\"\n },\n \"staleDate\": \"<string>\",\n \"dismissalDate\": \"<string>\",\n \"timestamp\": 1\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {},
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"details": {}
},
"metadata": {
"timestamp": "<string>",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}Authorizations
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
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Required string length:
1 - 256Available options:
start, update, end Show child attributes
Show child attributes
Required string length:
1 - 128Required string length:
1 - 128Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
40Maximum string length:
40Available options:
high, normal Required range:
x >= 0