Send a human a one-way notification
curl --request POST \
--url https://api.example.com/api/notifications \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"message": "<string>",
"audience": "<string>",
"channel": "<string>",
"data": {
"options": {},
"values": {}
},
"footer": "<string>",
"form_tag": "<string>",
"header": {
"url": "<string>",
"caption": "<string>",
"filename": "<string>"
},
"location": {
"latitude": 123,
"longitude": 123,
"address": "<string>",
"name": "<string>"
},
"media": [
{
"url": "<string>",
"caption": "<string>",
"filename": "<string>"
}
],
"options": [
{
"text": "<string>",
"description": "<string>",
"id": "<string>",
"kind": "reply"
}
],
"pages": [
{
"fields": [
"<string>"
],
"title": "<string>",
"button_label": "<string>",
"display": [],
"kind": "input"
}
],
"recipient": "<string>",
"schema": {},
"sections": [
{
"rows": [
{
"text": "<string>",
"description": "<string>",
"id": "<string>",
"kind": "reply"
}
],
"title": "<string>"
}
],
"sender_identity": "<string>",
"template": {
"language": "<string>",
"name": "<string>",
"parameters": {}
},
"wording": {
"answer": {
"confirm": "<string>",
"decline": "<string>",
"open": "<string>",
"rejected": "<string>",
"rejected_final": "<string>",
"reply_hint": "<string>",
"submit": "<string>"
},
"answer_page": {
"awaiting": {
"heading": "<string>",
"text": "<string>"
},
"confirm": {
"heading": "<string>",
"text": "<string>"
},
"done": {
"heading": "<string>",
"text": "<string>"
},
"form": {
"choose_one": "<string>",
"date_unavailable": "<string>",
"failed": "<string>",
"network_error": "<string>"
},
"submitted": {
"heading": "<string>",
"text": "<string>"
}
},
"choice": {
"group_label": "<string>",
"label": "<string>",
"reply_hint": "<string>"
},
"form": {
"back": "<string>",
"cancel": "<string>",
"error_line": "<string>",
"fields": {},
"open": "<string>",
"review_empty": "<string>",
"step_progress": "<string>",
"submit": "<string>",
"title": "<string>",
"update_failed": "<string>"
},
"lines": {
"answer_link": "<string>",
"deadline": "<string>",
"options": "<string>",
"reply": "<string>"
},
"status": {
"answered": "<string>",
"closed": "<string>",
"countdown": {
"one_second_left": "<string>",
"seconds_left": "<string>",
"under_half_minute": "<string>",
"under_minute": "<string>",
"under_ten_seconds": "<string>"
},
"expired": "<string>",
"sending": "<string>",
"sent": "<string>",
"unavailable": "<string>"
}
}
}
'import requests
url = "https://api.example.com/api/notifications"
payload = {
"message": "<string>",
"audience": "<string>",
"channel": "<string>",
"data": {
"options": {},
"values": {}
},
"footer": "<string>",
"form_tag": "<string>",
"header": {
"url": "<string>",
"caption": "<string>",
"filename": "<string>"
},
"location": {
"latitude": 123,
"longitude": 123,
"address": "<string>",
"name": "<string>"
},
"media": [
{
"url": "<string>",
"caption": "<string>",
"filename": "<string>"
}
],
"options": [
{
"text": "<string>",
"description": "<string>",
"id": "<string>",
"kind": "reply"
}
],
"pages": [
{
"fields": ["<string>"],
"title": "<string>",
"button_label": "<string>",
"display": [],
"kind": "input"
}
],
"recipient": "<string>",
"schema": {},
"sections": [
{
"rows": [
{
"text": "<string>",
"description": "<string>",
"id": "<string>",
"kind": "reply"
}
],
"title": "<string>"
}
],
"sender_identity": "<string>",
"template": {
"language": "<string>",
"name": "<string>",
"parameters": {}
},
"wording": {
"answer": {
"confirm": "<string>",
"decline": "<string>",
"open": "<string>",
"rejected": "<string>",
"rejected_final": "<string>",
"reply_hint": "<string>",
"submit": "<string>"
},
"answer_page": {
"awaiting": {
"heading": "<string>",
"text": "<string>"
},
"confirm": {
"heading": "<string>",
"text": "<string>"
},
"done": {
"heading": "<string>",
"text": "<string>"
},
"form": {
"choose_one": "<string>",
"date_unavailable": "<string>",
"failed": "<string>",
"network_error": "<string>"
},
"submitted": {
"heading": "<string>",
"text": "<string>"
}
},
"choice": {
"group_label": "<string>",
"label": "<string>",
"reply_hint": "<string>"
},
"form": {
"back": "<string>",
"cancel": "<string>",
"error_line": "<string>",
"fields": {},
"open": "<string>",
"review_empty": "<string>",
"step_progress": "<string>",
"submit": "<string>",
"title": "<string>",
"update_failed": "<string>"
},
"lines": {
"answer_link": "<string>",
"deadline": "<string>",
"options": "<string>",
"reply": "<string>"
},
"status": {
"answered": "<string>",
"closed": "<string>",
"countdown": {
"one_second_left": "<string>",
"seconds_left": "<string>",
"under_half_minute": "<string>",
"under_minute": "<string>",
"under_ten_seconds": "<string>"
},
"expired": "<string>",
"sending": "<string>",
"sent": "<string>",
"unavailable": "<string>"
}
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
message: '<string>',
audience: '<string>',
channel: '<string>',
data: {options: {}, values: {}},
footer: '<string>',
form_tag: '<string>',
header: {url: '<string>', caption: '<string>', filename: '<string>'},
location: {latitude: 123, longitude: 123, address: '<string>', name: '<string>'},
media: [{url: '<string>', caption: '<string>', filename: '<string>'}],
options: [{text: '<string>', description: '<string>', id: '<string>', kind: 'reply'}],
pages: [
{
fields: ['<string>'],
title: '<string>',
button_label: '<string>',
display: [],
kind: 'input'
}
],
recipient: '<string>',
schema: {},
sections: [
{
rows: [{text: '<string>', description: '<string>', id: '<string>', kind: 'reply'}],
title: '<string>'
}
],
sender_identity: '<string>',
template: {language: '<string>', name: '<string>', parameters: {}},
wording: {
answer: {
confirm: '<string>',
decline: '<string>',
open: '<string>',
rejected: '<string>',
rejected_final: '<string>',
reply_hint: '<string>',
submit: '<string>'
},
answer_page: {
awaiting: {heading: '<string>', text: '<string>'},
confirm: {heading: '<string>', text: '<string>'},
done: {heading: '<string>', text: '<string>'},
form: {
choose_one: '<string>',
date_unavailable: '<string>',
failed: '<string>',
network_error: '<string>'
},
submitted: {heading: '<string>', text: '<string>'}
},
choice: {group_label: '<string>', label: '<string>', reply_hint: '<string>'},
form: {
back: '<string>',
cancel: '<string>',
error_line: '<string>',
fields: {},
open: '<string>',
review_empty: '<string>',
step_progress: '<string>',
submit: '<string>',
title: '<string>',
update_failed: '<string>'
},
lines: {
answer_link: '<string>',
deadline: '<string>',
options: '<string>',
reply: '<string>'
},
status: {
answered: '<string>',
closed: '<string>',
countdown: {
one_second_left: '<string>',
seconds_left: '<string>',
under_half_minute: '<string>',
under_minute: '<string>',
under_ten_seconds: '<string>'
},
expired: '<string>',
sending: '<string>',
sent: '<string>',
unavailable: '<string>'
}
}
})
};
fetch('https://api.example.com/api/notifications', 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.example.com/api/notifications",
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([
'message' => '<string>',
'audience' => '<string>',
'channel' => '<string>',
'data' => [
'options' => [
],
'values' => [
]
],
'footer' => '<string>',
'form_tag' => '<string>',
'header' => [
'url' => '<string>',
'caption' => '<string>',
'filename' => '<string>'
],
'location' => [
'latitude' => 123,
'longitude' => 123,
'address' => '<string>',
'name' => '<string>'
],
'media' => [
[
'url' => '<string>',
'caption' => '<string>',
'filename' => '<string>'
]
],
'options' => [
[
'text' => '<string>',
'description' => '<string>',
'id' => '<string>',
'kind' => 'reply'
]
],
'pages' => [
[
'fields' => [
'<string>'
],
'title' => '<string>',
'button_label' => '<string>',
'display' => [
],
'kind' => 'input'
]
],
'recipient' => '<string>',
'schema' => [
],
'sections' => [
[
'rows' => [
[
'text' => '<string>',
'description' => '<string>',
'id' => '<string>',
'kind' => 'reply'
]
],
'title' => '<string>'
]
],
'sender_identity' => '<string>',
'template' => [
'language' => '<string>',
'name' => '<string>',
'parameters' => [
]
],
'wording' => [
'answer' => [
'confirm' => '<string>',
'decline' => '<string>',
'open' => '<string>',
'rejected' => '<string>',
'rejected_final' => '<string>',
'reply_hint' => '<string>',
'submit' => '<string>'
],
'answer_page' => [
'awaiting' => [
'heading' => '<string>',
'text' => '<string>'
],
'confirm' => [
'heading' => '<string>',
'text' => '<string>'
],
'done' => [
'heading' => '<string>',
'text' => '<string>'
],
'form' => [
'choose_one' => '<string>',
'date_unavailable' => '<string>',
'failed' => '<string>',
'network_error' => '<string>'
],
'submitted' => [
'heading' => '<string>',
'text' => '<string>'
]
],
'choice' => [
'group_label' => '<string>',
'label' => '<string>',
'reply_hint' => '<string>'
],
'form' => [
'back' => '<string>',
'cancel' => '<string>',
'error_line' => '<string>',
'fields' => [
],
'open' => '<string>',
'review_empty' => '<string>',
'step_progress' => '<string>',
'submit' => '<string>',
'title' => '<string>',
'update_failed' => '<string>'
],
'lines' => [
'answer_link' => '<string>',
'deadline' => '<string>',
'options' => '<string>',
'reply' => '<string>'
],
'status' => [
'answered' => '<string>',
'closed' => '<string>',
'countdown' => [
'one_second_left' => '<string>',
'seconds_left' => '<string>',
'under_half_minute' => '<string>',
'under_minute' => '<string>',
'under_ten_seconds' => '<string>'
],
'expired' => '<string>',
'sending' => '<string>',
'sent' => '<string>',
'unavailable' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.example.com/api/notifications"
payload := strings.NewReader("{\n \"message\": \"<string>\",\n \"audience\": \"<string>\",\n \"channel\": \"<string>\",\n \"data\": {\n \"options\": {},\n \"values\": {}\n },\n \"footer\": \"<string>\",\n \"form_tag\": \"<string>\",\n \"header\": {\n \"url\": \"<string>\",\n \"caption\": \"<string>\",\n \"filename\": \"<string>\"\n },\n \"location\": {\n \"latitude\": 123,\n \"longitude\": 123,\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"media\": [\n {\n \"url\": \"<string>\",\n \"caption\": \"<string>\",\n \"filename\": \"<string>\"\n }\n ],\n \"options\": [\n {\n \"text\": \"<string>\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"kind\": \"reply\"\n }\n ],\n \"pages\": [\n {\n \"fields\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"button_label\": \"<string>\",\n \"display\": [],\n \"kind\": \"input\"\n }\n ],\n \"recipient\": \"<string>\",\n \"schema\": {},\n \"sections\": [\n {\n \"rows\": [\n {\n \"text\": \"<string>\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"kind\": \"reply\"\n }\n ],\n \"title\": \"<string>\"\n }\n ],\n \"sender_identity\": \"<string>\",\n \"template\": {\n \"language\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": {}\n },\n \"wording\": {\n \"answer\": {\n \"confirm\": \"<string>\",\n \"decline\": \"<string>\",\n \"open\": \"<string>\",\n \"rejected\": \"<string>\",\n \"rejected_final\": \"<string>\",\n \"reply_hint\": \"<string>\",\n \"submit\": \"<string>\"\n },\n \"answer_page\": {\n \"awaiting\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"confirm\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"done\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"form\": {\n \"choose_one\": \"<string>\",\n \"date_unavailable\": \"<string>\",\n \"failed\": \"<string>\",\n \"network_error\": \"<string>\"\n },\n \"submitted\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n }\n },\n \"choice\": {\n \"group_label\": \"<string>\",\n \"label\": \"<string>\",\n \"reply_hint\": \"<string>\"\n },\n \"form\": {\n \"back\": \"<string>\",\n \"cancel\": \"<string>\",\n \"error_line\": \"<string>\",\n \"fields\": {},\n \"open\": \"<string>\",\n \"review_empty\": \"<string>\",\n \"step_progress\": \"<string>\",\n \"submit\": \"<string>\",\n \"title\": \"<string>\",\n \"update_failed\": \"<string>\"\n },\n \"lines\": {\n \"answer_link\": \"<string>\",\n \"deadline\": \"<string>\",\n \"options\": \"<string>\",\n \"reply\": \"<string>\"\n },\n \"status\": {\n \"answered\": \"<string>\",\n \"closed\": \"<string>\",\n \"countdown\": {\n \"one_second_left\": \"<string>\",\n \"seconds_left\": \"<string>\",\n \"under_half_minute\": \"<string>\",\n \"under_minute\": \"<string>\",\n \"under_ten_seconds\": \"<string>\"\n },\n \"expired\": \"<string>\",\n \"sending\": \"<string>\",\n \"sent\": \"<string>\",\n \"unavailable\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.example.com/api/notifications")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"<string>\",\n \"audience\": \"<string>\",\n \"channel\": \"<string>\",\n \"data\": {\n \"options\": {},\n \"values\": {}\n },\n \"footer\": \"<string>\",\n \"form_tag\": \"<string>\",\n \"header\": {\n \"url\": \"<string>\",\n \"caption\": \"<string>\",\n \"filename\": \"<string>\"\n },\n \"location\": {\n \"latitude\": 123,\n \"longitude\": 123,\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"media\": [\n {\n \"url\": \"<string>\",\n \"caption\": \"<string>\",\n \"filename\": \"<string>\"\n }\n ],\n \"options\": [\n {\n \"text\": \"<string>\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"kind\": \"reply\"\n }\n ],\n \"pages\": [\n {\n \"fields\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"button_label\": \"<string>\",\n \"display\": [],\n \"kind\": \"input\"\n }\n ],\n \"recipient\": \"<string>\",\n \"schema\": {},\n \"sections\": [\n {\n \"rows\": [\n {\n \"text\": \"<string>\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"kind\": \"reply\"\n }\n ],\n \"title\": \"<string>\"\n }\n ],\n \"sender_identity\": \"<string>\",\n \"template\": {\n \"language\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": {}\n },\n \"wording\": {\n \"answer\": {\n \"confirm\": \"<string>\",\n \"decline\": \"<string>\",\n \"open\": \"<string>\",\n \"rejected\": \"<string>\",\n \"rejected_final\": \"<string>\",\n \"reply_hint\": \"<string>\",\n \"submit\": \"<string>\"\n },\n \"answer_page\": {\n \"awaiting\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"confirm\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"done\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"form\": {\n \"choose_one\": \"<string>\",\n \"date_unavailable\": \"<string>\",\n \"failed\": \"<string>\",\n \"network_error\": \"<string>\"\n },\n \"submitted\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n }\n },\n \"choice\": {\n \"group_label\": \"<string>\",\n \"label\": \"<string>\",\n \"reply_hint\": \"<string>\"\n },\n \"form\": {\n \"back\": \"<string>\",\n \"cancel\": \"<string>\",\n \"error_line\": \"<string>\",\n \"fields\": {},\n \"open\": \"<string>\",\n \"review_empty\": \"<string>\",\n \"step_progress\": \"<string>\",\n \"submit\": \"<string>\",\n \"title\": \"<string>\",\n \"update_failed\": \"<string>\"\n },\n \"lines\": {\n \"answer_link\": \"<string>\",\n \"deadline\": \"<string>\",\n \"options\": \"<string>\",\n \"reply\": \"<string>\"\n },\n \"status\": {\n \"answered\": \"<string>\",\n \"closed\": \"<string>\",\n \"countdown\": {\n \"one_second_left\": \"<string>\",\n \"seconds_left\": \"<string>\",\n \"under_half_minute\": \"<string>\",\n \"under_minute\": \"<string>\",\n \"under_ten_seconds\": \"<string>\"\n },\n \"expired\": \"<string>\",\n \"sending\": \"<string>\",\n \"sent\": \"<string>\",\n \"unavailable\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/notifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"message\": \"<string>\",\n \"audience\": \"<string>\",\n \"channel\": \"<string>\",\n \"data\": {\n \"options\": {},\n \"values\": {}\n },\n \"footer\": \"<string>\",\n \"form_tag\": \"<string>\",\n \"header\": {\n \"url\": \"<string>\",\n \"caption\": \"<string>\",\n \"filename\": \"<string>\"\n },\n \"location\": {\n \"latitude\": 123,\n \"longitude\": 123,\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"media\": [\n {\n \"url\": \"<string>\",\n \"caption\": \"<string>\",\n \"filename\": \"<string>\"\n }\n ],\n \"options\": [\n {\n \"text\": \"<string>\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"kind\": \"reply\"\n }\n ],\n \"pages\": [\n {\n \"fields\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"button_label\": \"<string>\",\n \"display\": [],\n \"kind\": \"input\"\n }\n ],\n \"recipient\": \"<string>\",\n \"schema\": {},\n \"sections\": [\n {\n \"rows\": [\n {\n \"text\": \"<string>\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"kind\": \"reply\"\n }\n ],\n \"title\": \"<string>\"\n }\n ],\n \"sender_identity\": \"<string>\",\n \"template\": {\n \"language\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": {}\n },\n \"wording\": {\n \"answer\": {\n \"confirm\": \"<string>\",\n \"decline\": \"<string>\",\n \"open\": \"<string>\",\n \"rejected\": \"<string>\",\n \"rejected_final\": \"<string>\",\n \"reply_hint\": \"<string>\",\n \"submit\": \"<string>\"\n },\n \"answer_page\": {\n \"awaiting\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"confirm\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"done\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"form\": {\n \"choose_one\": \"<string>\",\n \"date_unavailable\": \"<string>\",\n \"failed\": \"<string>\",\n \"network_error\": \"<string>\"\n },\n \"submitted\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n }\n },\n \"choice\": {\n \"group_label\": \"<string>\",\n \"label\": \"<string>\",\n \"reply_hint\": \"<string>\"\n },\n \"form\": {\n \"back\": \"<string>\",\n \"cancel\": \"<string>\",\n \"error_line\": \"<string>\",\n \"fields\": {},\n \"open\": \"<string>\",\n \"review_empty\": \"<string>\",\n \"step_progress\": \"<string>\",\n \"submit\": \"<string>\",\n \"title\": \"<string>\",\n \"update_failed\": \"<string>\"\n },\n \"lines\": {\n \"answer_link\": \"<string>\",\n \"deadline\": \"<string>\",\n \"options\": \"<string>\",\n \"reply\": \"<string>\"\n },\n \"status\": {\n \"answered\": \"<string>\",\n \"closed\": \"<string>\",\n \"countdown\": {\n \"one_second_left\": \"<string>\",\n \"seconds_left\": \"<string>\",\n \"under_half_minute\": \"<string>\",\n \"under_minute\": \"<string>\",\n \"under_ten_seconds\": \"<string>\"\n },\n \"expired\": \"<string>\",\n \"sending\": \"<string>\",\n \"sent\": \"<string>\",\n \"unavailable\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}notifications
Send a human a one-way notification
Send a human a one-way notification, fire-and-forget.
No reply is expected and nothing blocks. With a named channel the message is
sent and the call returns as soon as the medium ACCEPTED it (not that a human
saw it). With channel omitted the message is recorded to the internal
notifications sink the Studio inbox reads. One send attempt, no retry; every
failure raises loudly, never a silent no-op:
- a blank message with no media to carry it (the contract admits a blank message
only for a media-only send), an unknown channel name, a blank recipient/audience, a
caller-supplied
sender_identity, a contract-invalidmedia/template/options/schemacombination (an empty list/dict, an over-cap value, or a mutually exclusive media+template / options+template / schema+template / schema+options), aschemawith no channel (the internal sink has no submission door) or one the channel’s form subset/hook refuses, or a channel’s permanent refusal of the input’s shape (retrying cannot succeed) → 400; - a restricted caller addressing another identity (cross-identity denial) → 403;
- a channel that cannot notify, or does not advertise the
media/template/options/schemacapability the send needs → 501; - a transient channel delivery failure (the raised error’s
retryable) → 503, carrying the medium’sretry_afterwhen it named one; - a permanent channel delivery refusal → 502.
media (display media sent with the message), location (a shared map pin),
template (a pre-approved out-of-window send), options (FLAT tappable options a tap
of which enters the conversation), sections (the SECTIONED tappable-options
alternative), header/footer (a media header / trailing line composing an interactive
message) and schema (an ask-less form’s answer schema — the channel renders the
message as the form’s prompt, and a submission enters the conversation as a message from
the person) are OPTIONAL richer-send forms — FULL parity with the turn answer path’s
AnswerPart vocabulary. The contract’s shared composition matrix is enforced on this
request model identically: options XOR sections (one choice surface); schema
excludes both; header/footer require a choice surface; template is the standalone
out-of-window send exclusive with every other content/interactive field; options/
sections may each combine with media/location (a contract-invalid combination is
a 400). On a
named channel each needs a channel that advertises the matching capability
(media→media, location→location, template→template, options/sections→
interactive, schema→form; header/footer ride the choice surface’s capability, no
flag of their own) — otherwise
the send is refused as a 501, never downgraded to a silent freeform send. With no
channel media/location/template/options/sections/header/footer are stored on the internal
inbox record and rendered
there; schema alone REQUIRES a channel (a 400 without one) — a stored form nobody
could submit would be a dead surface, not a notification.
data (per-send prefill values and per-send options lists) and pages (the
stepped layout) are the ask-less form’s per-send extras — the same FormData/FormPage
an ask carries. They ride ONLY a form send: present without schema is a 400. When a
schema is present each is cross-checked against it by the same validator the ask door
runs — a prefill against an unknown/ill-typed property, a per-send option list on a
non-string property, or a page that omits/duplicates/misnames a property is a 400.
form_tag is the caller-set opaque per-send correlation the channel carries with the form
and hands back on submit. It rides ONLY a form send: present without schema is a 400. The
platform bounds it (an out-of-charset or over-length tag is a 400) but never interprets it,
and it is not written to the in-app feed record.
wording is the per-send catalogue of the notification’s platform-drawn texts, grouped by
what each decorates — form (a form send’s chrome), choice (a choice list’s control
words) and status (in-flight status copy). Each member is admitted only on the surface that
draws it (a schema form, a flat options list, or a sectioned sections list); a
member on a notification with no such surface is a 400. It is display content, so an
audience-addressed send records it on the in-app feed.
audience addresses the in-app record to an identity’s feed; it is honored
even when a channel also delivers the message (channel push AND in-app record).
sender_identity is the sending identity a channel message leaves FROM, which the
conversation bridge sets on the notification it builds to answer a route; a caller may
not supply it here and a set value is rejected loudly, never forwarded to the channel.
Returns a short confirmation string — "notification sent via '<channel>'"
for a channel send, "notification recorded to the internal sink" otherwise.
POST
/
api
/
notifications
Send a human a one-way notification
curl --request POST \
--url https://api.example.com/api/notifications \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"message": "<string>",
"audience": "<string>",
"channel": "<string>",
"data": {
"options": {},
"values": {}
},
"footer": "<string>",
"form_tag": "<string>",
"header": {
"url": "<string>",
"caption": "<string>",
"filename": "<string>"
},
"location": {
"latitude": 123,
"longitude": 123,
"address": "<string>",
"name": "<string>"
},
"media": [
{
"url": "<string>",
"caption": "<string>",
"filename": "<string>"
}
],
"options": [
{
"text": "<string>",
"description": "<string>",
"id": "<string>",
"kind": "reply"
}
],
"pages": [
{
"fields": [
"<string>"
],
"title": "<string>",
"button_label": "<string>",
"display": [],
"kind": "input"
}
],
"recipient": "<string>",
"schema": {},
"sections": [
{
"rows": [
{
"text": "<string>",
"description": "<string>",
"id": "<string>",
"kind": "reply"
}
],
"title": "<string>"
}
],
"sender_identity": "<string>",
"template": {
"language": "<string>",
"name": "<string>",
"parameters": {}
},
"wording": {
"answer": {
"confirm": "<string>",
"decline": "<string>",
"open": "<string>",
"rejected": "<string>",
"rejected_final": "<string>",
"reply_hint": "<string>",
"submit": "<string>"
},
"answer_page": {
"awaiting": {
"heading": "<string>",
"text": "<string>"
},
"confirm": {
"heading": "<string>",
"text": "<string>"
},
"done": {
"heading": "<string>",
"text": "<string>"
},
"form": {
"choose_one": "<string>",
"date_unavailable": "<string>",
"failed": "<string>",
"network_error": "<string>"
},
"submitted": {
"heading": "<string>",
"text": "<string>"
}
},
"choice": {
"group_label": "<string>",
"label": "<string>",
"reply_hint": "<string>"
},
"form": {
"back": "<string>",
"cancel": "<string>",
"error_line": "<string>",
"fields": {},
"open": "<string>",
"review_empty": "<string>",
"step_progress": "<string>",
"submit": "<string>",
"title": "<string>",
"update_failed": "<string>"
},
"lines": {
"answer_link": "<string>",
"deadline": "<string>",
"options": "<string>",
"reply": "<string>"
},
"status": {
"answered": "<string>",
"closed": "<string>",
"countdown": {
"one_second_left": "<string>",
"seconds_left": "<string>",
"under_half_minute": "<string>",
"under_minute": "<string>",
"under_ten_seconds": "<string>"
},
"expired": "<string>",
"sending": "<string>",
"sent": "<string>",
"unavailable": "<string>"
}
}
}
'import requests
url = "https://api.example.com/api/notifications"
payload = {
"message": "<string>",
"audience": "<string>",
"channel": "<string>",
"data": {
"options": {},
"values": {}
},
"footer": "<string>",
"form_tag": "<string>",
"header": {
"url": "<string>",
"caption": "<string>",
"filename": "<string>"
},
"location": {
"latitude": 123,
"longitude": 123,
"address": "<string>",
"name": "<string>"
},
"media": [
{
"url": "<string>",
"caption": "<string>",
"filename": "<string>"
}
],
"options": [
{
"text": "<string>",
"description": "<string>",
"id": "<string>",
"kind": "reply"
}
],
"pages": [
{
"fields": ["<string>"],
"title": "<string>",
"button_label": "<string>",
"display": [],
"kind": "input"
}
],
"recipient": "<string>",
"schema": {},
"sections": [
{
"rows": [
{
"text": "<string>",
"description": "<string>",
"id": "<string>",
"kind": "reply"
}
],
"title": "<string>"
}
],
"sender_identity": "<string>",
"template": {
"language": "<string>",
"name": "<string>",
"parameters": {}
},
"wording": {
"answer": {
"confirm": "<string>",
"decline": "<string>",
"open": "<string>",
"rejected": "<string>",
"rejected_final": "<string>",
"reply_hint": "<string>",
"submit": "<string>"
},
"answer_page": {
"awaiting": {
"heading": "<string>",
"text": "<string>"
},
"confirm": {
"heading": "<string>",
"text": "<string>"
},
"done": {
"heading": "<string>",
"text": "<string>"
},
"form": {
"choose_one": "<string>",
"date_unavailable": "<string>",
"failed": "<string>",
"network_error": "<string>"
},
"submitted": {
"heading": "<string>",
"text": "<string>"
}
},
"choice": {
"group_label": "<string>",
"label": "<string>",
"reply_hint": "<string>"
},
"form": {
"back": "<string>",
"cancel": "<string>",
"error_line": "<string>",
"fields": {},
"open": "<string>",
"review_empty": "<string>",
"step_progress": "<string>",
"submit": "<string>",
"title": "<string>",
"update_failed": "<string>"
},
"lines": {
"answer_link": "<string>",
"deadline": "<string>",
"options": "<string>",
"reply": "<string>"
},
"status": {
"answered": "<string>",
"closed": "<string>",
"countdown": {
"one_second_left": "<string>",
"seconds_left": "<string>",
"under_half_minute": "<string>",
"under_minute": "<string>",
"under_ten_seconds": "<string>"
},
"expired": "<string>",
"sending": "<string>",
"sent": "<string>",
"unavailable": "<string>"
}
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
message: '<string>',
audience: '<string>',
channel: '<string>',
data: {options: {}, values: {}},
footer: '<string>',
form_tag: '<string>',
header: {url: '<string>', caption: '<string>', filename: '<string>'},
location: {latitude: 123, longitude: 123, address: '<string>', name: '<string>'},
media: [{url: '<string>', caption: '<string>', filename: '<string>'}],
options: [{text: '<string>', description: '<string>', id: '<string>', kind: 'reply'}],
pages: [
{
fields: ['<string>'],
title: '<string>',
button_label: '<string>',
display: [],
kind: 'input'
}
],
recipient: '<string>',
schema: {},
sections: [
{
rows: [{text: '<string>', description: '<string>', id: '<string>', kind: 'reply'}],
title: '<string>'
}
],
sender_identity: '<string>',
template: {language: '<string>', name: '<string>', parameters: {}},
wording: {
answer: {
confirm: '<string>',
decline: '<string>',
open: '<string>',
rejected: '<string>',
rejected_final: '<string>',
reply_hint: '<string>',
submit: '<string>'
},
answer_page: {
awaiting: {heading: '<string>', text: '<string>'},
confirm: {heading: '<string>', text: '<string>'},
done: {heading: '<string>', text: '<string>'},
form: {
choose_one: '<string>',
date_unavailable: '<string>',
failed: '<string>',
network_error: '<string>'
},
submitted: {heading: '<string>', text: '<string>'}
},
choice: {group_label: '<string>', label: '<string>', reply_hint: '<string>'},
form: {
back: '<string>',
cancel: '<string>',
error_line: '<string>',
fields: {},
open: '<string>',
review_empty: '<string>',
step_progress: '<string>',
submit: '<string>',
title: '<string>',
update_failed: '<string>'
},
lines: {
answer_link: '<string>',
deadline: '<string>',
options: '<string>',
reply: '<string>'
},
status: {
answered: '<string>',
closed: '<string>',
countdown: {
one_second_left: '<string>',
seconds_left: '<string>',
under_half_minute: '<string>',
under_minute: '<string>',
under_ten_seconds: '<string>'
},
expired: '<string>',
sending: '<string>',
sent: '<string>',
unavailable: '<string>'
}
}
})
};
fetch('https://api.example.com/api/notifications', 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.example.com/api/notifications",
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([
'message' => '<string>',
'audience' => '<string>',
'channel' => '<string>',
'data' => [
'options' => [
],
'values' => [
]
],
'footer' => '<string>',
'form_tag' => '<string>',
'header' => [
'url' => '<string>',
'caption' => '<string>',
'filename' => '<string>'
],
'location' => [
'latitude' => 123,
'longitude' => 123,
'address' => '<string>',
'name' => '<string>'
],
'media' => [
[
'url' => '<string>',
'caption' => '<string>',
'filename' => '<string>'
]
],
'options' => [
[
'text' => '<string>',
'description' => '<string>',
'id' => '<string>',
'kind' => 'reply'
]
],
'pages' => [
[
'fields' => [
'<string>'
],
'title' => '<string>',
'button_label' => '<string>',
'display' => [
],
'kind' => 'input'
]
],
'recipient' => '<string>',
'schema' => [
],
'sections' => [
[
'rows' => [
[
'text' => '<string>',
'description' => '<string>',
'id' => '<string>',
'kind' => 'reply'
]
],
'title' => '<string>'
]
],
'sender_identity' => '<string>',
'template' => [
'language' => '<string>',
'name' => '<string>',
'parameters' => [
]
],
'wording' => [
'answer' => [
'confirm' => '<string>',
'decline' => '<string>',
'open' => '<string>',
'rejected' => '<string>',
'rejected_final' => '<string>',
'reply_hint' => '<string>',
'submit' => '<string>'
],
'answer_page' => [
'awaiting' => [
'heading' => '<string>',
'text' => '<string>'
],
'confirm' => [
'heading' => '<string>',
'text' => '<string>'
],
'done' => [
'heading' => '<string>',
'text' => '<string>'
],
'form' => [
'choose_one' => '<string>',
'date_unavailable' => '<string>',
'failed' => '<string>',
'network_error' => '<string>'
],
'submitted' => [
'heading' => '<string>',
'text' => '<string>'
]
],
'choice' => [
'group_label' => '<string>',
'label' => '<string>',
'reply_hint' => '<string>'
],
'form' => [
'back' => '<string>',
'cancel' => '<string>',
'error_line' => '<string>',
'fields' => [
],
'open' => '<string>',
'review_empty' => '<string>',
'step_progress' => '<string>',
'submit' => '<string>',
'title' => '<string>',
'update_failed' => '<string>'
],
'lines' => [
'answer_link' => '<string>',
'deadline' => '<string>',
'options' => '<string>',
'reply' => '<string>'
],
'status' => [
'answered' => '<string>',
'closed' => '<string>',
'countdown' => [
'one_second_left' => '<string>',
'seconds_left' => '<string>',
'under_half_minute' => '<string>',
'under_minute' => '<string>',
'under_ten_seconds' => '<string>'
],
'expired' => '<string>',
'sending' => '<string>',
'sent' => '<string>',
'unavailable' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.example.com/api/notifications"
payload := strings.NewReader("{\n \"message\": \"<string>\",\n \"audience\": \"<string>\",\n \"channel\": \"<string>\",\n \"data\": {\n \"options\": {},\n \"values\": {}\n },\n \"footer\": \"<string>\",\n \"form_tag\": \"<string>\",\n \"header\": {\n \"url\": \"<string>\",\n \"caption\": \"<string>\",\n \"filename\": \"<string>\"\n },\n \"location\": {\n \"latitude\": 123,\n \"longitude\": 123,\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"media\": [\n {\n \"url\": \"<string>\",\n \"caption\": \"<string>\",\n \"filename\": \"<string>\"\n }\n ],\n \"options\": [\n {\n \"text\": \"<string>\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"kind\": \"reply\"\n }\n ],\n \"pages\": [\n {\n \"fields\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"button_label\": \"<string>\",\n \"display\": [],\n \"kind\": \"input\"\n }\n ],\n \"recipient\": \"<string>\",\n \"schema\": {},\n \"sections\": [\n {\n \"rows\": [\n {\n \"text\": \"<string>\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"kind\": \"reply\"\n }\n ],\n \"title\": \"<string>\"\n }\n ],\n \"sender_identity\": \"<string>\",\n \"template\": {\n \"language\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": {}\n },\n \"wording\": {\n \"answer\": {\n \"confirm\": \"<string>\",\n \"decline\": \"<string>\",\n \"open\": \"<string>\",\n \"rejected\": \"<string>\",\n \"rejected_final\": \"<string>\",\n \"reply_hint\": \"<string>\",\n \"submit\": \"<string>\"\n },\n \"answer_page\": {\n \"awaiting\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"confirm\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"done\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"form\": {\n \"choose_one\": \"<string>\",\n \"date_unavailable\": \"<string>\",\n \"failed\": \"<string>\",\n \"network_error\": \"<string>\"\n },\n \"submitted\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n }\n },\n \"choice\": {\n \"group_label\": \"<string>\",\n \"label\": \"<string>\",\n \"reply_hint\": \"<string>\"\n },\n \"form\": {\n \"back\": \"<string>\",\n \"cancel\": \"<string>\",\n \"error_line\": \"<string>\",\n \"fields\": {},\n \"open\": \"<string>\",\n \"review_empty\": \"<string>\",\n \"step_progress\": \"<string>\",\n \"submit\": \"<string>\",\n \"title\": \"<string>\",\n \"update_failed\": \"<string>\"\n },\n \"lines\": {\n \"answer_link\": \"<string>\",\n \"deadline\": \"<string>\",\n \"options\": \"<string>\",\n \"reply\": \"<string>\"\n },\n \"status\": {\n \"answered\": \"<string>\",\n \"closed\": \"<string>\",\n \"countdown\": {\n \"one_second_left\": \"<string>\",\n \"seconds_left\": \"<string>\",\n \"under_half_minute\": \"<string>\",\n \"under_minute\": \"<string>\",\n \"under_ten_seconds\": \"<string>\"\n },\n \"expired\": \"<string>\",\n \"sending\": \"<string>\",\n \"sent\": \"<string>\",\n \"unavailable\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.example.com/api/notifications")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"<string>\",\n \"audience\": \"<string>\",\n \"channel\": \"<string>\",\n \"data\": {\n \"options\": {},\n \"values\": {}\n },\n \"footer\": \"<string>\",\n \"form_tag\": \"<string>\",\n \"header\": {\n \"url\": \"<string>\",\n \"caption\": \"<string>\",\n \"filename\": \"<string>\"\n },\n \"location\": {\n \"latitude\": 123,\n \"longitude\": 123,\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"media\": [\n {\n \"url\": \"<string>\",\n \"caption\": \"<string>\",\n \"filename\": \"<string>\"\n }\n ],\n \"options\": [\n {\n \"text\": \"<string>\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"kind\": \"reply\"\n }\n ],\n \"pages\": [\n {\n \"fields\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"button_label\": \"<string>\",\n \"display\": [],\n \"kind\": \"input\"\n }\n ],\n \"recipient\": \"<string>\",\n \"schema\": {},\n \"sections\": [\n {\n \"rows\": [\n {\n \"text\": \"<string>\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"kind\": \"reply\"\n }\n ],\n \"title\": \"<string>\"\n }\n ],\n \"sender_identity\": \"<string>\",\n \"template\": {\n \"language\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": {}\n },\n \"wording\": {\n \"answer\": {\n \"confirm\": \"<string>\",\n \"decline\": \"<string>\",\n \"open\": \"<string>\",\n \"rejected\": \"<string>\",\n \"rejected_final\": \"<string>\",\n \"reply_hint\": \"<string>\",\n \"submit\": \"<string>\"\n },\n \"answer_page\": {\n \"awaiting\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"confirm\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"done\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"form\": {\n \"choose_one\": \"<string>\",\n \"date_unavailable\": \"<string>\",\n \"failed\": \"<string>\",\n \"network_error\": \"<string>\"\n },\n \"submitted\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n }\n },\n \"choice\": {\n \"group_label\": \"<string>\",\n \"label\": \"<string>\",\n \"reply_hint\": \"<string>\"\n },\n \"form\": {\n \"back\": \"<string>\",\n \"cancel\": \"<string>\",\n \"error_line\": \"<string>\",\n \"fields\": {},\n \"open\": \"<string>\",\n \"review_empty\": \"<string>\",\n \"step_progress\": \"<string>\",\n \"submit\": \"<string>\",\n \"title\": \"<string>\",\n \"update_failed\": \"<string>\"\n },\n \"lines\": {\n \"answer_link\": \"<string>\",\n \"deadline\": \"<string>\",\n \"options\": \"<string>\",\n \"reply\": \"<string>\"\n },\n \"status\": {\n \"answered\": \"<string>\",\n \"closed\": \"<string>\",\n \"countdown\": {\n \"one_second_left\": \"<string>\",\n \"seconds_left\": \"<string>\",\n \"under_half_minute\": \"<string>\",\n \"under_minute\": \"<string>\",\n \"under_ten_seconds\": \"<string>\"\n },\n \"expired\": \"<string>\",\n \"sending\": \"<string>\",\n \"sent\": \"<string>\",\n \"unavailable\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/notifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"message\": \"<string>\",\n \"audience\": \"<string>\",\n \"channel\": \"<string>\",\n \"data\": {\n \"options\": {},\n \"values\": {}\n },\n \"footer\": \"<string>\",\n \"form_tag\": \"<string>\",\n \"header\": {\n \"url\": \"<string>\",\n \"caption\": \"<string>\",\n \"filename\": \"<string>\"\n },\n \"location\": {\n \"latitude\": 123,\n \"longitude\": 123,\n \"address\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"media\": [\n {\n \"url\": \"<string>\",\n \"caption\": \"<string>\",\n \"filename\": \"<string>\"\n }\n ],\n \"options\": [\n {\n \"text\": \"<string>\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"kind\": \"reply\"\n }\n ],\n \"pages\": [\n {\n \"fields\": [\n \"<string>\"\n ],\n \"title\": \"<string>\",\n \"button_label\": \"<string>\",\n \"display\": [],\n \"kind\": \"input\"\n }\n ],\n \"recipient\": \"<string>\",\n \"schema\": {},\n \"sections\": [\n {\n \"rows\": [\n {\n \"text\": \"<string>\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"kind\": \"reply\"\n }\n ],\n \"title\": \"<string>\"\n }\n ],\n \"sender_identity\": \"<string>\",\n \"template\": {\n \"language\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": {}\n },\n \"wording\": {\n \"answer\": {\n \"confirm\": \"<string>\",\n \"decline\": \"<string>\",\n \"open\": \"<string>\",\n \"rejected\": \"<string>\",\n \"rejected_final\": \"<string>\",\n \"reply_hint\": \"<string>\",\n \"submit\": \"<string>\"\n },\n \"answer_page\": {\n \"awaiting\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"confirm\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"done\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n },\n \"form\": {\n \"choose_one\": \"<string>\",\n \"date_unavailable\": \"<string>\",\n \"failed\": \"<string>\",\n \"network_error\": \"<string>\"\n },\n \"submitted\": {\n \"heading\": \"<string>\",\n \"text\": \"<string>\"\n }\n },\n \"choice\": {\n \"group_label\": \"<string>\",\n \"label\": \"<string>\",\n \"reply_hint\": \"<string>\"\n },\n \"form\": {\n \"back\": \"<string>\",\n \"cancel\": \"<string>\",\n \"error_line\": \"<string>\",\n \"fields\": {},\n \"open\": \"<string>\",\n \"review_empty\": \"<string>\",\n \"step_progress\": \"<string>\",\n \"submit\": \"<string>\",\n \"title\": \"<string>\",\n \"update_failed\": \"<string>\"\n },\n \"lines\": {\n \"answer_link\": \"<string>\",\n \"deadline\": \"<string>\",\n \"options\": \"<string>\",\n \"reply\": \"<string>\"\n },\n \"status\": {\n \"answered\": \"<string>\",\n \"closed\": \"<string>\",\n \"countdown\": {\n \"one_second_left\": \"<string>\",\n \"seconds_left\": \"<string>\",\n \"under_half_minute\": \"<string>\",\n \"under_minute\": \"<string>\",\n \"under_ten_seconds\": \"<string>\"\n },\n \"expired\": \"<string>\",\n \"sending\": \"<string>\",\n \"sent\": \"<string>\",\n \"unavailable\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Authorizations
Body
application/json
A notification to send.
The message text, an optional named channel that carries it (omit to record to the internal sink),
an optional per-call recipient delivery address, and an optional audience identity whose in-app
inbox shows it (honored even with a channel set; distinct from recipient).
The identity (user_id) whose in-app inbox shows this (honored even with a channel set); leave unset for an operator/broadcast notification. Distinct from recipient, which is a channel delivery address.
Optional per-send form data over schema: values prefills top-level properties and options supplies a per-send choice list for a string (or array-of-strings) property (replacing its enum for this send). Rides ONLY a form send — present without schema is a 400. A prefill against an unknown/ill-typed property, or an option list on a non-string property, is a 400.
Show child attributes
Show child attributes
Optional short trailing line under an interactive message. Like the header it COMPOSES an interactive message, so it REQUIRES options or sections; it rides the choice surface's own capability (no separate flag) and mutually exclusive with template.
Optional caller-set opaque per-send form tag the channel carries with the form and hands back on submit. Rides ONLY a form send — present without schema is a 400. Bounded as transport (an out-of-charset or over-length tag is a 400) but never interpreted; not written to the in-app feed record.
Optional single display-media header above an interactive message. It COMPOSES an interactive message, so it REQUIRES options or sections; it rides the interactive choice surface's own capability (no separate flag) and mutually exclusive with template.
Show child attributes
Show child attributes
Optional shared geographic point sent WITH the message (a map pin). On a named channel it requires a channel that advertises location support (else a 501); with no channel it is stored on the internal inbox record. It may carry the message content on its own (a blank message is admissible when media or a location carries it). Mutually exclusive with template.
Show child attributes
Show child attributes
Optional display media sent WITH the message. On a named channel it requires a channel that advertises media support (else a 501); with no channel it is stored on the internal inbox record and rendered there. Mutually exclusive with template.
Show child attributes
Show child attributes
Optional FLAT tappable options sent WITH the message — each a reply option (a tap submits its text as a visitor message) or a link option (a tap opens its url). On a named channel it requires a channel that advertises interactive support (else a 501); with no channel it is stored on the internal inbox record. One message carries ONE interactive surface: mutually exclusive with template, sections and schema; may combine with media and location.
A tappable suggested reply.
Tapping SUBMITS text as the participant's next inbound message —
the quick-reply / list-row case, where the option's own text becomes the turn. description
is an OPTIONAL secondary line a sectioned-list row renders under its text; a channel that
renders flat buttons (no descriptions) ignores it.
id is an OPTIONAL author-set stable identifier for the button/list row. When set, a channel
sends it verbatim on the wire and the participant's tap echoes it back (a channel surfaces the echoed
id to the inbound turn as opaque enrichment — e.g. Slack forwards it as params.reply_id);
when None the channel mints its own id. Bounded by the platform abuse bound
OPTION_ID_MAX_CHARS and a single-line non-blank label; a channel with a tighter id cap
enforces it in its own code. Frozen.
- ReplyOption
- LinkOption
Show child attributes
Show child attributes
Optional stepped layout over schema: each page names the top-level properties shown on one step, and across the pages every property appears exactly once. Rides ONLY a form send — present without schema is a 400. A page that omits, duplicates, or names an unknown property is a 400.
Show child attributes
Show child attributes
Optional form answer schema for an ask-less form: the channel renders the message as the form's prompt and this schema as the fillable form, and a submission enters the conversation as a message from the person. Requires a named channel (else a 400 — the internal sink has no submission door) that advertises form support (else a 501). Mutually exclusive with template and with options, may combine with media.
Optional SECTIONED tappable options — titled groups of reply rows, the sectioned alternative to the flat options list (rows summed across sections stay within the same cap). On a named channel it requires a channel that advertises interactive support (else a 501); with no channel it is stored on the internal inbox record. One message carries ONE interactive surface: mutually exclusive with options, template and schema; may combine with media and location.
Show child attributes
Show child attributes
Reserved: the sending identity a channel message leaves FROM, set by the conversation bridge on the notification it builds to answer a route. Callers MUST NOT supply it here — a set value is rejected with a 400, never forwarded.
Optional pre-approved template for an out-of-window send. On a named channel it requires a channel that advertises template support (else a 501); with no channel it is stored on the internal inbox record. Mutually exclusive with media and options.
Show child attributes
Show child attributes
Optional per-send catalogue of the notification's platform-drawn texts, grouped by what each decorates — form (a form send's chrome), choice (a choice list's control words) and status (in-flight status copy). Each member is admitted only on the surface that draws it (a schema form, a flat options list, or a sectioned list); a member on a notification with no such surface is a 400. Recorded on the in-app feed (display content, feed parity).
Show child attributes
Show child attributes
Response
Success.
The notify-user body: a bare confirmation STRING.
The adapter envelopes it as {"data": <str>}. Typed as a string rather
than wrapped, so the wire body is unchanged.