Replace a Structured Widget snapshot
curl --request POST \
--url https://app.layarva.com/api/public/v1/widgets/{widgetId}/data/push \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"pushVersion": 1,
"widgetType": "TODAYS_SCHEDULE",
"writeMode": "REPLACE_SNAPSHOT",
"source": {
"eventId": "cms-agenda-sync-20260827-001",
"sequence": 101,
"generatedAt": "2026-08-27T08:00:00+07:00"
},
"data": {
"schemaVersion": 2,
"title": "Today's Agenda",
"locale": "en-US",
"timezone": "Asia/Jakarta",
"date": "2026-08-27",
"updatedAt": "2026-08-27T08:00:00+07:00",
"items": [
{
"id": "agenda-001",
"startAt": "2026-08-27T09:00:00+07:00",
"endAt": "2026-08-27T09:30:00+07:00",
"title": "Morning Briefing",
"location": "Meeting Room A",
"status": "SCHEDULED"
}
]
}
}
EOFimport requests
url = "https://app.layarva.com/api/public/v1/widgets/{widgetId}/data/push"
payload = {
"pushVersion": 1,
"widgetType": "TODAYS_SCHEDULE",
"writeMode": "REPLACE_SNAPSHOT",
"source": {
"eventId": "cms-agenda-sync-20260827-001",
"sequence": 101,
"generatedAt": "2026-08-27T08:00:00+07:00"
},
"data": {
"schemaVersion": 2,
"title": "Today's Agenda",
"locale": "en-US",
"timezone": "Asia/Jakarta",
"date": "2026-08-27",
"updatedAt": "2026-08-27T08:00:00+07:00",
"items": [
{
"id": "agenda-001",
"startAt": "2026-08-27T09:00:00+07:00",
"endAt": "2026-08-27T09:30:00+07:00",
"title": "Morning Briefing",
"location": "Meeting Room A",
"status": "SCHEDULED"
}
]
}
}
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({
pushVersion: 1,
widgetType: 'TODAYS_SCHEDULE',
writeMode: 'REPLACE_SNAPSHOT',
source: {
eventId: 'cms-agenda-sync-20260827-001',
sequence: 101,
generatedAt: '2026-08-27T08:00:00+07:00'
},
data: {
schemaVersion: 2,
title: 'Today\'s Agenda',
locale: 'en-US',
timezone: 'Asia/Jakarta',
date: '2026-08-27',
updatedAt: '2026-08-27T08:00:00+07:00',
items: [
{
id: 'agenda-001',
startAt: '2026-08-27T09:00:00+07:00',
endAt: '2026-08-27T09:30:00+07:00',
title: 'Morning Briefing',
location: 'Meeting Room A',
status: 'SCHEDULED'
}
]
}
})
};
fetch('https://app.layarva.com/api/public/v1/widgets/{widgetId}/data/push', 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://app.layarva.com/api/public/v1/widgets/{widgetId}/data/push",
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([
'pushVersion' => 1,
'widgetType' => 'TODAYS_SCHEDULE',
'writeMode' => 'REPLACE_SNAPSHOT',
'source' => [
'eventId' => 'cms-agenda-sync-20260827-001',
'sequence' => 101,
'generatedAt' => '2026-08-27T08:00:00+07:00'
],
'data' => [
'schemaVersion' => 2,
'title' => 'Today\'s Agenda',
'locale' => 'en-US',
'timezone' => 'Asia/Jakarta',
'date' => '2026-08-27',
'updatedAt' => '2026-08-27T08:00:00+07:00',
'items' => [
[
'id' => 'agenda-001',
'startAt' => '2026-08-27T09:00:00+07:00',
'endAt' => '2026-08-27T09:30:00+07:00',
'title' => 'Morning Briefing',
'location' => 'Meeting Room A',
'status' => 'SCHEDULED'
]
]
]
]),
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://app.layarva.com/api/public/v1/widgets/{widgetId}/data/push"
payload := strings.NewReader("{\n \"pushVersion\": 1,\n \"widgetType\": \"TODAYS_SCHEDULE\",\n \"writeMode\": \"REPLACE_SNAPSHOT\",\n \"source\": {\n \"eventId\": \"cms-agenda-sync-20260827-001\",\n \"sequence\": 101,\n \"generatedAt\": \"2026-08-27T08:00:00+07:00\"\n },\n \"data\": {\n \"schemaVersion\": 2,\n \"title\": \"Today's Agenda\",\n \"locale\": \"en-US\",\n \"timezone\": \"Asia/Jakarta\",\n \"date\": \"2026-08-27\",\n \"updatedAt\": \"2026-08-27T08:00:00+07:00\",\n \"items\": [\n {\n \"id\": \"agenda-001\",\n \"startAt\": \"2026-08-27T09:00:00+07:00\",\n \"endAt\": \"2026-08-27T09:30:00+07:00\",\n \"title\": \"Morning Briefing\",\n \"location\": \"Meeting Room A\",\n \"status\": \"SCHEDULED\"\n }\n ]\n }\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://app.layarva.com/api/public/v1/widgets/{widgetId}/data/push")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"pushVersion\": 1,\n \"widgetType\": \"TODAYS_SCHEDULE\",\n \"writeMode\": \"REPLACE_SNAPSHOT\",\n \"source\": {\n \"eventId\": \"cms-agenda-sync-20260827-001\",\n \"sequence\": 101,\n \"generatedAt\": \"2026-08-27T08:00:00+07:00\"\n },\n \"data\": {\n \"schemaVersion\": 2,\n \"title\": \"Today's Agenda\",\n \"locale\": \"en-US\",\n \"timezone\": \"Asia/Jakarta\",\n \"date\": \"2026-08-27\",\n \"updatedAt\": \"2026-08-27T08:00:00+07:00\",\n \"items\": [\n {\n \"id\": \"agenda-001\",\n \"startAt\": \"2026-08-27T09:00:00+07:00\",\n \"endAt\": \"2026-08-27T09:30:00+07:00\",\n \"title\": \"Morning Briefing\",\n \"location\": \"Meeting Room A\",\n \"status\": \"SCHEDULED\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.layarva.com/api/public/v1/widgets/{widgetId}/data/push")
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 \"pushVersion\": 1,\n \"widgetType\": \"TODAYS_SCHEDULE\",\n \"writeMode\": \"REPLACE_SNAPSHOT\",\n \"source\": {\n \"eventId\": \"cms-agenda-sync-20260827-001\",\n \"sequence\": 101,\n \"generatedAt\": \"2026-08-27T08:00:00+07:00\"\n },\n \"data\": {\n \"schemaVersion\": 2,\n \"title\": \"Today's Agenda\",\n \"locale\": \"en-US\",\n \"timezone\": \"Asia/Jakarta\",\n \"date\": \"2026-08-27\",\n \"updatedAt\": \"2026-08-27T08:00:00+07:00\",\n \"items\": [\n {\n \"id\": \"agenda-001\",\n \"startAt\": \"2026-08-27T09:00:00+07:00\",\n \"endAt\": \"2026-08-27T09:30:00+07:00\",\n \"title\": \"Morning Briefing\",\n \"location\": \"Meeting Room A\",\n \"status\": \"SCHEDULED\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"accepted": true,
"widgetId": "<string>",
"widgetType": "ANNOUNCEMENTS",
"dataRevision": 2,
"schemaVersion": 2,
"acceptedAt": "2023-11-07T05:31:56Z",
"itemCount": 1,
"warnings": [
"<string>"
]
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Structured Widget API Reference
Replace a Structured Widget snapshot
Replaces the complete semantic-data snapshot for one active Structured Widget v2 source. Partial patches are not supported.
POST
/
api
/
public
/
v1
/
widgets
/
{widgetId}
/
data
/
push
Replace a Structured Widget snapshot
curl --request POST \
--url https://app.layarva.com/api/public/v1/widgets/{widgetId}/data/push \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"pushVersion": 1,
"widgetType": "TODAYS_SCHEDULE",
"writeMode": "REPLACE_SNAPSHOT",
"source": {
"eventId": "cms-agenda-sync-20260827-001",
"sequence": 101,
"generatedAt": "2026-08-27T08:00:00+07:00"
},
"data": {
"schemaVersion": 2,
"title": "Today's Agenda",
"locale": "en-US",
"timezone": "Asia/Jakarta",
"date": "2026-08-27",
"updatedAt": "2026-08-27T08:00:00+07:00",
"items": [
{
"id": "agenda-001",
"startAt": "2026-08-27T09:00:00+07:00",
"endAt": "2026-08-27T09:30:00+07:00",
"title": "Morning Briefing",
"location": "Meeting Room A",
"status": "SCHEDULED"
}
]
}
}
EOFimport requests
url = "https://app.layarva.com/api/public/v1/widgets/{widgetId}/data/push"
payload = {
"pushVersion": 1,
"widgetType": "TODAYS_SCHEDULE",
"writeMode": "REPLACE_SNAPSHOT",
"source": {
"eventId": "cms-agenda-sync-20260827-001",
"sequence": 101,
"generatedAt": "2026-08-27T08:00:00+07:00"
},
"data": {
"schemaVersion": 2,
"title": "Today's Agenda",
"locale": "en-US",
"timezone": "Asia/Jakarta",
"date": "2026-08-27",
"updatedAt": "2026-08-27T08:00:00+07:00",
"items": [
{
"id": "agenda-001",
"startAt": "2026-08-27T09:00:00+07:00",
"endAt": "2026-08-27T09:30:00+07:00",
"title": "Morning Briefing",
"location": "Meeting Room A",
"status": "SCHEDULED"
}
]
}
}
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({
pushVersion: 1,
widgetType: 'TODAYS_SCHEDULE',
writeMode: 'REPLACE_SNAPSHOT',
source: {
eventId: 'cms-agenda-sync-20260827-001',
sequence: 101,
generatedAt: '2026-08-27T08:00:00+07:00'
},
data: {
schemaVersion: 2,
title: 'Today\'s Agenda',
locale: 'en-US',
timezone: 'Asia/Jakarta',
date: '2026-08-27',
updatedAt: '2026-08-27T08:00:00+07:00',
items: [
{
id: 'agenda-001',
startAt: '2026-08-27T09:00:00+07:00',
endAt: '2026-08-27T09:30:00+07:00',
title: 'Morning Briefing',
location: 'Meeting Room A',
status: 'SCHEDULED'
}
]
}
})
};
fetch('https://app.layarva.com/api/public/v1/widgets/{widgetId}/data/push', 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://app.layarva.com/api/public/v1/widgets/{widgetId}/data/push",
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([
'pushVersion' => 1,
'widgetType' => 'TODAYS_SCHEDULE',
'writeMode' => 'REPLACE_SNAPSHOT',
'source' => [
'eventId' => 'cms-agenda-sync-20260827-001',
'sequence' => 101,
'generatedAt' => '2026-08-27T08:00:00+07:00'
],
'data' => [
'schemaVersion' => 2,
'title' => 'Today\'s Agenda',
'locale' => 'en-US',
'timezone' => 'Asia/Jakarta',
'date' => '2026-08-27',
'updatedAt' => '2026-08-27T08:00:00+07:00',
'items' => [
[
'id' => 'agenda-001',
'startAt' => '2026-08-27T09:00:00+07:00',
'endAt' => '2026-08-27T09:30:00+07:00',
'title' => 'Morning Briefing',
'location' => 'Meeting Room A',
'status' => 'SCHEDULED'
]
]
]
]),
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://app.layarva.com/api/public/v1/widgets/{widgetId}/data/push"
payload := strings.NewReader("{\n \"pushVersion\": 1,\n \"widgetType\": \"TODAYS_SCHEDULE\",\n \"writeMode\": \"REPLACE_SNAPSHOT\",\n \"source\": {\n \"eventId\": \"cms-agenda-sync-20260827-001\",\n \"sequence\": 101,\n \"generatedAt\": \"2026-08-27T08:00:00+07:00\"\n },\n \"data\": {\n \"schemaVersion\": 2,\n \"title\": \"Today's Agenda\",\n \"locale\": \"en-US\",\n \"timezone\": \"Asia/Jakarta\",\n \"date\": \"2026-08-27\",\n \"updatedAt\": \"2026-08-27T08:00:00+07:00\",\n \"items\": [\n {\n \"id\": \"agenda-001\",\n \"startAt\": \"2026-08-27T09:00:00+07:00\",\n \"endAt\": \"2026-08-27T09:30:00+07:00\",\n \"title\": \"Morning Briefing\",\n \"location\": \"Meeting Room A\",\n \"status\": \"SCHEDULED\"\n }\n ]\n }\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://app.layarva.com/api/public/v1/widgets/{widgetId}/data/push")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"pushVersion\": 1,\n \"widgetType\": \"TODAYS_SCHEDULE\",\n \"writeMode\": \"REPLACE_SNAPSHOT\",\n \"source\": {\n \"eventId\": \"cms-agenda-sync-20260827-001\",\n \"sequence\": 101,\n \"generatedAt\": \"2026-08-27T08:00:00+07:00\"\n },\n \"data\": {\n \"schemaVersion\": 2,\n \"title\": \"Today's Agenda\",\n \"locale\": \"en-US\",\n \"timezone\": \"Asia/Jakarta\",\n \"date\": \"2026-08-27\",\n \"updatedAt\": \"2026-08-27T08:00:00+07:00\",\n \"items\": [\n {\n \"id\": \"agenda-001\",\n \"startAt\": \"2026-08-27T09:00:00+07:00\",\n \"endAt\": \"2026-08-27T09:30:00+07:00\",\n \"title\": \"Morning Briefing\",\n \"location\": \"Meeting Room A\",\n \"status\": \"SCHEDULED\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.layarva.com/api/public/v1/widgets/{widgetId}/data/push")
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 \"pushVersion\": 1,\n \"widgetType\": \"TODAYS_SCHEDULE\",\n \"writeMode\": \"REPLACE_SNAPSHOT\",\n \"source\": {\n \"eventId\": \"cms-agenda-sync-20260827-001\",\n \"sequence\": 101,\n \"generatedAt\": \"2026-08-27T08:00:00+07:00\"\n },\n \"data\": {\n \"schemaVersion\": 2,\n \"title\": \"Today's Agenda\",\n \"locale\": \"en-US\",\n \"timezone\": \"Asia/Jakarta\",\n \"date\": \"2026-08-27\",\n \"updatedAt\": \"2026-08-27T08:00:00+07:00\",\n \"items\": [\n {\n \"id\": \"agenda-001\",\n \"startAt\": \"2026-08-27T09:00:00+07:00\",\n \"endAt\": \"2026-08-27T09:30:00+07:00\",\n \"title\": \"Morning Briefing\",\n \"location\": \"Meeting Room A\",\n \"status\": \"SCHEDULED\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"accepted": true,
"widgetId": "<string>",
"widgetType": "ANNOUNCEMENTS",
"dataRevision": 2,
"schemaVersion": 2,
"acceptedAt": "2023-11-07T05:31:56Z",
"itemCount": 1,
"warnings": [
"<string>"
]
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
workspaceBearerworkspaceApiKeyHeader
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Strongly recommended stable identity for one logical snapshot. Retained for 24 hours.
Required string length:
8 - 180Path Parameters
Unique Widget ID copied from the Studio API integration dialog.
Body
application/json
Available options:
ANNOUNCEMENTS, TODAYS_SCHEDULE, EVENTS, TRANSPORT_BOARD Allowed value:
"REPLACE_SNAPSHOT"Strict semantic payload. Its shape must match widgetType and the target Widget.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Snapshot accepted or an identical idempotent request replayed
Available options:
ANNOUNCEMENTS, TODAYS_SCHEDULE, EVENTS, TRANSPORT_BOARD Required range:
x >= 1Required range:
x >= 0