Pharmacies (Pharmacy groups and cooperatives), Recall notice 1.0.0
| Template | Pharmacies (Pharmacy groups and cooperatives), tpl_582d4bae23ad |
|---|---|
| Variant | Recall notice |
| Version | 1.0.0, the newest: what a channel following this variant draws |
| Shapes | 9x16, 4x5, 1x1, 16x9, 2x3 |
| Length | 16 seconds |
Example video
The 1x1 cut of this version, drawn from its own worked example. Open the video on its own.
What it accepts
A pharmacy group's batch recall in a Bauhaus look: the notice's date in the circle, the product and why, complete on the first frame; the batches one by one; what to do, the first step in bold, then the steps in turn; the button and the pharmacist. The source line and the mandatory text stay at the foot throughout. 14 seconds, plus a little per batch. metaData is never drawn.
| Field | Type | Required | Limit | What it is |
|---|---|---|---|---|
clipData | group | yes | Clip data: Everything drawn in the clip: the notice, its date, the product, why, the batches with their expiry, the first instruction, the steps, the labels, the call to action, the source line and the mandatory text. | |
clipData.campaign | text | yes | up to 40 characters | Notice: What this post is, over the product beside a square of your colour, such as Product recall or Safety notice. |
clipData.month | datetime | yes | Date of the notice: The day the authority or the maker issued the notice. Its day, month and year are written in the circle in the channel's language. | |
clipData.monthText | text | up to 12 characters | Circle, as written: The circle's word in your own words, shown instead of the date, such as Recall. Short words fill the circle best. | |
clipData.product | text | yes | up to 70 characters | Product: The recalled product as the notice names it, with its pack size. |
clipData.detail | text | up to 80 characters | Pack and maker: The pack or the maker, under the product, so people can find it on the shelf. | |
clipData.reason | text | up to 200 characters | Why: Why it is recalled, in plain and calm words, as the notice gives it. No more than the notice says. | |
clipData.batches | list | yes | at least 1, up to 8 | Batches: One to eight affected batch numbers, each as printed on the pack, with the expiry date as printed where the notice names one. A page is added where they do not fit; about two thirds of a second each. |
clipData.batches[] | group | Batch | ||
clipData.batches[].batch | text | yes | up to 28 characters | Batch number: Exactly as printed on the pack. |
clipData.batches[].expiry | text | up to 28 characters | Expiry: The expiry date as printed, with the words you want, such as Expires 11/2027. | |
clipData.caution | text | yes | up to 120 characters | The one thing to do: The first instruction, set in bold with a mark. Plain and calm, such as Please stop using the syrup from these batches. |
clipData.actions | list | yes | at least 1, up to 4 | What to do: One to four steps, read in turn with their numbers, as the notice gives them. |
clipData.actions[] | group | Step | ||
clipData.actions[].text | text | yes | up to 110 characters | Step: One instruction, in a short sentence. |
clipData.labels | group | Labels: The words over the scenes, in your language. A label left out is not drawn. | ||
clipData.labels.batches | text | up to 40 characters | Batches: Over the batch numbers. | |
clipData.labels.actions | text | up to 40 characters | What to do: Over the steps. | |
clipData.source | text | yes | up to 160 characters | Source: Who issued the notice and when, shown over the mandatory text on every frame, never cut. Required: a recall says where it comes from. |
clipData.cta | group | Call to action: The button at the end and the line under it, such as a web address, the app or a phone number. | ||
clipData.cta.label | text | yes | up to 28 characters | Button: What the button says. |
clipData.cta.detail | text | up to 48 characters | Line under it: A web address, the app, a phone number. | |
clipData.mandatory | text | yes | up to 320 characters | Mandatory text: The mandatory text your country's law asks for wherever a medicine is named, such as "Always read the label." in the UK or the Pflichttext in Germany. Shown whole at the foot of every frame, set smaller and then on more lines, never cut. |
clipData.look | group | Look: How the clip looks and moves. The same six switches in every format (theme, pace, corners, alignment, logo, logo size). Leave any out for the package's default: the brand's colours, the standard pace, square corners, text at the start. | ||
clipData.look.theme | enum | brand, light, dark, bold | Theme: Brand: your brand's own colours and background. Light or dark: a page tinted with your brand colour. Bold: your brand colour as the page. | |
clipData.look.pace | enum | calm, standard, punchy | Pace: How things arrive: calm fades, a standard rhythm, or punchy slams and hard cuts. | |
clipData.look.corners | enum | square, soft, round | Corners: The shape of cards, pictures and buttons. | |
clipData.look.align | enum | start, centre | Text alignment: Where the text lines up. | |
clipData.look.logo | enum | auto, free | Logo: The style's own: the logo on a small plate so it reads on any page. As it is: the logo whole, with no plate, frame or crop, for a logo made to stand on the page, such as one with a transparent background. As it is, make sure your logo reads on the page of the theme you choose. | |
clipData.look.logoSize | enum | auto, small, large | Logo size: Standard is the style's own size. Small draws the logo a fifth smaller, with its plate. Large draws it a quarter larger wherever the style has room for it, and at the standard size where it has none. | |
metaData | group | Meta data: Everything about the post that is never drawn in the clip: its title, its description in four lengths, one per kind of platform, and its hashtags. Reelwire adds the brand's description, link and hashtags after it. Left out, the post text is generated from the clip data. | ||
metaData.title | text | up to 100 characters | Title: Used where the platform has a title of its own: Facebook Feed, LinkedIn, Pinterest and YouTube. Up to 100 characters, which every one of them takes. | |
metaData.captionTiny | text | up to 200 characters | Tiny description (Pinterest, Threads, X): Up to 200 characters. The brand's description, link and hashtags follow it within the platform's limit. | |
metaData.captionShort | text | up to 500 characters | Short description (Telegram, Threema, WeChat, WhatsApp): Up to 500 characters. The brand's description, link and hashtags follow it within the platform's limit. | |
metaData.captionMedium | text | up to 1500 characters | Medium description (Discord, Facebook Reels, Instagram, LinkedIn, Signal, Slack, TikTok): Up to 1500 characters. The brand's description, link and hashtags follow it within the platform's limit. | |
metaData.captionLong | text | up to 4000 characters | Long description (Facebook Feed, YouTube): Up to 4000 characters. The brand's description, link and hashtags follow it within the platform's limit. | |
metaData.hashtags | list | up to 15 | Hashtags: Written without the #. Up to 15, which every platform takes. | |
metaData.hashtags[] | text | up to 60 characters | Hashtag |
locales carries other languages: under each language code, the parts of clipData and metaData that differ, laid over the default, so a language with no copy still renders.
A picture is always a file from your media library: media:// followed by its id or its name.
Anything the table does not list is refused, and so is anything over its limit, with a 400
schema_validation error that names the field.
The JSON Schema
{
"type": "object",
"properties": {
"clipData": {
"type": "object",
"properties": {
"campaign": {
"type": "string",
"maxLength": 40,
"title": "Notice",
"description": "What this post is, over the product beside a square of your colour, such as Product recall or Safety notice."
},
"month": {
"type": "string",
"format": "date-time",
"title": "Date of the notice",
"description": "The day the authority or the maker issued the notice. Its day, month and year are written in the circle in the channel's language."
},
"monthText": {
"type": "string",
"maxLength": 12,
"title": "Circle, as written",
"description": "The circle's word in your own words, shown instead of the date, such as Recall. Short words fill the circle best."
},
"product": {
"type": "string",
"maxLength": 70,
"title": "Product",
"description": "The recalled product as the notice names it, with its pack size."
},
"detail": {
"type": "string",
"maxLength": 80,
"title": "Pack and maker",
"description": "The pack or the maker, under the product, so people can find it on the shelf."
},
"reason": {
"type": "string",
"maxLength": 200,
"title": "Why",
"description": "Why it is recalled, in plain and calm words, as the notice gives it. No more than the notice says."
},
"batches": {
"type": "array",
"items": {
"type": "object",
"properties": {
"batch": {
"type": "string",
"maxLength": 28,
"title": "Batch number",
"description": "Exactly as printed on the pack."
},
"expiry": {
"type": "string",
"maxLength": 28,
"title": "Expiry",
"description": "The expiry date as printed, with the words you want, such as Expires 11/2027."
}
},
"required": [
"batch"
],
"additionalProperties": false,
"title": "Batch"
},
"minItems": 1,
"maxItems": 8,
"title": "Batches",
"description": "One to eight affected batch numbers, each as printed on the pack, with the expiry date as printed where the notice names one. A page is added where they do not fit; about two thirds of a second each."
},
"caution": {
"type": "string",
"maxLength": 120,
"title": "The one thing to do",
"description": "The first instruction, set in bold with a mark. Plain and calm, such as Please stop using the syrup from these batches."
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string",
"maxLength": 110,
"title": "Step",
"description": "One instruction, in a short sentence."
}
},
"required": [
"text"
],
"additionalProperties": false,
"title": "Step"
},
"minItems": 1,
"maxItems": 4,
"title": "What to do",
"description": "One to four steps, read in turn with their numbers, as the notice gives them."
},
"labels": {
"type": "object",
"properties": {
"batches": {
"type": "string",
"maxLength": 40,
"title": "Batches",
"description": "Over the batch numbers."
},
"actions": {
"type": "string",
"maxLength": 40,
"title": "What to do",
"description": "Over the steps."
}
},
"additionalProperties": false,
"title": "Labels",
"description": "The words over the scenes, in your language. A label left out is not drawn."
},
"source": {
"type": "string",
"maxLength": 160,
"title": "Source",
"description": "Who issued the notice and when, shown over the mandatory text on every frame, never cut. Required: a recall says where it comes from."
},
"cta": {
"type": "object",
"properties": {
"label": {
"type": "string",
"maxLength": 28,
"title": "Button",
"description": "What the button says."
},
"detail": {
"type": "string",
"maxLength": 48,
"title": "Line under it",
"description": "A web address, the app, a phone number."
}
},
"required": [
"label"
],
"additionalProperties": false,
"title": "Call to action",
"description": "The button at the end and the line under it, such as a web address, the app or a phone number."
},
"mandatory": {
"type": "string",
"maxLength": 320,
"title": "Mandatory text",
"description": "The mandatory text your country's law asks for wherever a medicine is named, such as \"Always read the label.\" in the UK or the Pflichttext in Germany. Shown whole at the foot of every frame, set smaller and then on more lines, never cut."
},
"look": {
"type": "object",
"properties": {
"theme": {
"type": "string",
"enum": [
"brand",
"light",
"dark",
"bold"
],
"title": "Theme",
"description": "Brand: your brand's own colours and background. Light or dark: a page tinted with your brand colour. Bold: your brand colour as the page.",
"enumNames": [
"Brand colours",
"Light",
"Dark",
"Bold brand colour"
]
},
"pace": {
"type": "string",
"enum": [
"calm",
"standard",
"punchy"
],
"title": "Pace",
"description": "How things arrive: calm fades, a standard rhythm, or punchy slams and hard cuts.",
"enumNames": [
"Calm",
"Standard",
"Punchy"
]
},
"corners": {
"type": "string",
"enum": [
"square",
"soft",
"round"
],
"title": "Corners",
"description": "The shape of cards, pictures and buttons.",
"enumNames": [
"Square",
"Softly rounded",
"Round"
]
},
"align": {
"type": "string",
"enum": [
"start",
"centre"
],
"title": "Text alignment",
"description": "Where the text lines up.",
"enumNames": [
"At the start of the line",
"Centred"
]
},
"logo": {
"type": "string",
"enum": [
"auto",
"free"
],
"title": "Logo",
"description": "The style's own: the logo on a small plate so it reads on any page. As it is: the logo whole, with no plate, frame or crop, for a logo made to stand on the page, such as one with a transparent background. As it is, make sure your logo reads on the page of the theme you choose.",
"enumNames": [
"The style's own",
"As it is, no plate or crop"
]
},
"logoSize": {
"type": "string",
"enum": [
"auto",
"small",
"large"
],
"title": "Logo size",
"description": "Standard is the style's own size. Small draws the logo a fifth smaller, with its plate. Large draws it a quarter larger wherever the style has room for it, and at the standard size where it has none.",
"enumNames": [
"Standard",
"Small",
"Large"
]
}
},
"additionalProperties": false,
"title": "Look",
"description": "How the clip looks and moves. The same six switches in every format (theme, pace, corners, alignment, logo, logo size). Leave any out for the package's default: the brand's colours, the standard pace, square corners, text at the start."
}
},
"required": [
"campaign",
"month",
"product",
"batches",
"caution",
"actions",
"source",
"mandatory"
],
"additionalProperties": false,
"title": "Clip data",
"description": "Everything drawn in the clip: the notice, its date, the product, why, the batches with their expiry, the first instruction, the steps, the labels, the call to action, the source line and the mandatory text."
},
"metaData": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 100,
"title": "Title",
"description": "Used where the platform has a title of its own: Facebook Feed, LinkedIn, Pinterest and YouTube. Up to 100 characters, which every one of them takes."
},
"captionTiny": {
"type": "string",
"maxLength": 200,
"title": "Tiny description (Pinterest, Threads, X)",
"description": "Up to 200 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"captionShort": {
"type": "string",
"maxLength": 500,
"title": "Short description (Telegram, Threema, WeChat, WhatsApp)",
"description": "Up to 500 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"captionMedium": {
"type": "string",
"maxLength": 1500,
"title": "Medium description (Discord, Facebook Reels, Instagram, LinkedIn, Signal, Slack, TikTok)",
"description": "Up to 1500 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"captionLong": {
"type": "string",
"maxLength": 4000,
"title": "Long description (Facebook Feed, YouTube)",
"description": "Up to 4000 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"hashtags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"title": "Hashtag"
},
"maxItems": 15,
"title": "Hashtags",
"description": "Written without the #. Up to 15, which every platform takes."
}
},
"additionalProperties": false,
"title": "Meta data",
"description": "Everything about the post that is never drawn in the clip: its title, its description in four lengths, one per kind of platform, and its hashtags. Reelwire adds the brand's description, link and hashtags after it. Left out, the post text is generated from the clip data."
},
"locales": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"clipData": {
"type": "object",
"properties": {
"campaign": {
"type": "string",
"maxLength": 40,
"title": "Notice",
"description": "What this post is, over the product beside a square of your colour, such as Product recall or Safety notice."
},
"month": {
"type": "string",
"format": "date-time",
"title": "Date of the notice",
"description": "The day the authority or the maker issued the notice. Its day, month and year are written in the circle in the channel's language."
},
"monthText": {
"type": "string",
"maxLength": 12,
"title": "Circle, as written",
"description": "The circle's word in your own words, shown instead of the date, such as Recall. Short words fill the circle best."
},
"product": {
"type": "string",
"maxLength": 70,
"title": "Product",
"description": "The recalled product as the notice names it, with its pack size."
},
"detail": {
"type": "string",
"maxLength": 80,
"title": "Pack and maker",
"description": "The pack or the maker, under the product, so people can find it on the shelf."
},
"reason": {
"type": "string",
"maxLength": 200,
"title": "Why",
"description": "Why it is recalled, in plain and calm words, as the notice gives it. No more than the notice says."
},
"batches": {
"type": "array",
"items": {
"type": "object",
"properties": {
"batch": {
"type": "string",
"maxLength": 28,
"title": "Batch number",
"description": "Exactly as printed on the pack."
},
"expiry": {
"type": "string",
"maxLength": 28,
"title": "Expiry",
"description": "The expiry date as printed, with the words you want, such as Expires 11/2027."
}
},
"required": [
"batch"
],
"additionalProperties": false,
"title": "Batch"
},
"minItems": 1,
"maxItems": 8,
"title": "Batches",
"description": "One to eight affected batch numbers, each as printed on the pack, with the expiry date as printed where the notice names one. A page is added where they do not fit; about two thirds of a second each."
},
"caution": {
"type": "string",
"maxLength": 120,
"title": "The one thing to do",
"description": "The first instruction, set in bold with a mark. Plain and calm, such as Please stop using the syrup from these batches."
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string",
"maxLength": 110,
"title": "Step",
"description": "One instruction, in a short sentence."
}
},
"required": [
"text"
],
"additionalProperties": false,
"title": "Step"
},
"minItems": 1,
"maxItems": 4,
"title": "What to do",
"description": "One to four steps, read in turn with their numbers, as the notice gives them."
},
"labels": {
"type": "object",
"properties": {
"batches": {
"type": "string",
"maxLength": 40,
"title": "Batches",
"description": "Over the batch numbers."
},
"actions": {
"type": "string",
"maxLength": 40,
"title": "What to do",
"description": "Over the steps."
}
},
"additionalProperties": false,
"title": "Labels",
"description": "The words over the scenes, in your language. A label left out is not drawn."
},
"source": {
"type": "string",
"maxLength": 160,
"title": "Source",
"description": "Who issued the notice and when, shown over the mandatory text on every frame, never cut. Required: a recall says where it comes from."
},
"cta": {
"type": "object",
"properties": {
"label": {
"type": "string",
"maxLength": 28,
"title": "Button",
"description": "What the button says."
},
"detail": {
"type": "string",
"maxLength": 48,
"title": "Line under it",
"description": "A web address, the app, a phone number."
}
},
"additionalProperties": false,
"title": "Call to action",
"description": "The button at the end and the line under it, such as a web address, the app or a phone number."
},
"mandatory": {
"type": "string",
"maxLength": 320,
"title": "Mandatory text",
"description": "The mandatory text your country's law asks for wherever a medicine is named, such as \"Always read the label.\" in the UK or the Pflichttext in Germany. Shown whole at the foot of every frame, set smaller and then on more lines, never cut."
},
"look": {
"type": "object",
"properties": {
"theme": {
"type": "string",
"enum": [
"brand",
"light",
"dark",
"bold"
],
"title": "Theme",
"description": "Brand: your brand's own colours and background. Light or dark: a page tinted with your brand colour. Bold: your brand colour as the page.",
"enumNames": [
"Brand colours",
"Light",
"Dark",
"Bold brand colour"
]
},
"pace": {
"type": "string",
"enum": [
"calm",
"standard",
"punchy"
],
"title": "Pace",
"description": "How things arrive: calm fades, a standard rhythm, or punchy slams and hard cuts.",
"enumNames": [
"Calm",
"Standard",
"Punchy"
]
},
"corners": {
"type": "string",
"enum": [
"square",
"soft",
"round"
],
"title": "Corners",
"description": "The shape of cards, pictures and buttons.",
"enumNames": [
"Square",
"Softly rounded",
"Round"
]
},
"align": {
"type": "string",
"enum": [
"start",
"centre"
],
"title": "Text alignment",
"description": "Where the text lines up.",
"enumNames": [
"At the start of the line",
"Centred"
]
},
"logo": {
"type": "string",
"enum": [
"auto",
"free"
],
"title": "Logo",
"description": "The style's own: the logo on a small plate so it reads on any page. As it is: the logo whole, with no plate, frame or crop, for a logo made to stand on the page, such as one with a transparent background. As it is, make sure your logo reads on the page of the theme you choose.",
"enumNames": [
"The style's own",
"As it is, no plate or crop"
]
},
"logoSize": {
"type": "string",
"enum": [
"auto",
"small",
"large"
],
"title": "Logo size",
"description": "Standard is the style's own size. Small draws the logo a fifth smaller, with its plate. Large draws it a quarter larger wherever the style has room for it, and at the standard size where it has none.",
"enumNames": [
"Standard",
"Small",
"Large"
]
}
},
"additionalProperties": false,
"title": "Look",
"description": "How the clip looks and moves. The same six switches in every format (theme, pace, corners, alignment, logo, logo size). Leave any out for the package's default: the brand's colours, the standard pace, square corners, text at the start."
}
},
"additionalProperties": false,
"title": "Clip data",
"description": "Everything drawn in the clip: the notice, its date, the product, why, the batches with their expiry, the first instruction, the steps, the labels, the call to action, the source line and the mandatory text."
},
"metaData": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 100,
"title": "Title",
"description": "Used where the platform has a title of its own: Facebook Feed, LinkedIn, Pinterest and YouTube. Up to 100 characters, which every one of them takes."
},
"captionTiny": {
"type": "string",
"maxLength": 200,
"title": "Tiny description (Pinterest, Threads, X)",
"description": "Up to 200 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"captionShort": {
"type": "string",
"maxLength": 500,
"title": "Short description (Telegram, Threema, WeChat, WhatsApp)",
"description": "Up to 500 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"captionMedium": {
"type": "string",
"maxLength": 1500,
"title": "Medium description (Discord, Facebook Reels, Instagram, LinkedIn, Signal, Slack, TikTok)",
"description": "Up to 1500 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"captionLong": {
"type": "string",
"maxLength": 4000,
"title": "Long description (Facebook Feed, YouTube)",
"description": "Up to 4000 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"hashtags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"title": "Hashtag"
},
"maxItems": 15,
"title": "Hashtags",
"description": "Written without the #. Up to 15, which every platform takes."
}
},
"additionalProperties": false,
"title": "Meta data",
"description": "Everything about the post that is never drawn in the clip: its title, its description in four lengths, one per kind of platform, and its hashtags. Reelwire adds the brand's description, link and hashtags after it. Left out, the post text is generated from the clip data."
}
},
"additionalProperties": false
},
"propertyNames": {
"enum": [
"aa",
"ab",
"ae",
"af",
"ak",
"am",
"an",
"ar",
"as",
"av",
"ay",
"az",
"ba",
"be",
"bg",
"bi",
"bm",
"bn",
"bo",
"br",
"bs",
"ca",
"ce",
"ch",
"co",
"cr",
"cs",
"cu",
"cv",
"cy",
"da",
"de",
"dv",
"dz",
"ee",
"el",
"en",
"eo",
"es",
"et",
"eu",
"fa",
"ff",
"fi",
"fj",
"fo",
"fr",
"fy",
"ga",
"gd",
"gl",
"gn",
"gu",
"gv",
"ha",
"he",
"hi",
"ho",
"hr",
"ht",
"hu",
"hy",
"hz",
"ia",
"id",
"ie",
"ig",
"ii",
"ik",
"io",
"is",
"it",
"iu",
"ja",
"jv",
"ka",
"kg",
"ki",
"kj",
"kk",
"kl",
"km",
"kn",
"ko",
"kr",
"ks",
"ku",
"kv",
"kw",
"ky",
"la",
"lb",
"lg",
"li",
"ln",
"lo",
"lt",
"lu",
"lv",
"mg",
"mh",
"mi",
"mk",
"ml",
"mn",
"mr",
"ms",
"mt",
"my",
"na",
"nb",
"nd",
"ne",
"ng",
"nl",
"nn",
"no",
"nr",
"nv",
"ny",
"oc",
"oj",
"om",
"or",
"os",
"pa",
"pi",
"pl",
"ps",
"pt",
"qu",
"rm",
"rn",
"ro",
"ru",
"rw",
"sa",
"sc",
"sd",
"se",
"sg",
"si",
"sk",
"sl",
"sm",
"sn",
"so",
"sq",
"sr",
"ss",
"st",
"su",
"sv",
"sw",
"ta",
"te",
"tg",
"th",
"ti",
"tk",
"tl",
"tn",
"to",
"tr",
"ts",
"tt",
"tw",
"ty",
"ug",
"uk",
"ur",
"uz",
"ve",
"vi",
"vo",
"wa",
"wo",
"xh",
"yi",
"yo",
"za",
"zh",
"zu",
"zh-CN",
"zh-TW",
"pt-BR"
]
}
}
},
"required": [
"clipData"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}
Ask Reelwire for the same document yourself, without signing in:
curl "http://localhost:4000/v1/formats/template/tpl_582d4bae23ad?variant=Recall%20notice&version=1.0.0"
Delivery JSON
Your own system sends this to one of your streams, POST /v1/stream, and every channel listening to
that stream draws it with its template. data is the document described above; a stream with an
empty field map passes it to the template unchanged. Try it first on POST /v1/stream/validate,
which answers the same without publishing anything. Streams and feeds
explains the rest, including how to map a document of your own shape instead.
{
"streamId": "st_your_stream_id",
"eventId": "01M2SQMKK3G1NVFXV31DCBVB95",
"occurredAt": "2026-09-23T07:00:00Z",
"locale": "en",
"data": {
"clipData": {
"campaign": "Product recall",
"month": "2026-11-12T00:00:00+00:00",
"monthText": "",
"product": "Cold relief syrup, 100 ml",
"detail": "Cherry flavour, bottle with a white child-resistant cap",
"reason": "A laboratory check found that some bottles may hold less of the active ingredient than the label says.",
"batches": [
{
"batch": "CR24-1187",
"expiry": "Expires 11/2027"
},
{
"batch": "CR24-1188",
"expiry": "Expires 11/2027"
},
{
"batch": "CR25-0042",
"expiry": "Expires 02/2028"
}
],
"caution": "Please stop using the syrup from these batches.",
"actions": [
{
"text": "Check the batch number on the label of your bottle"
},
{
"text": "Bring it to any member pharmacy for a free replacement"
},
{
"text": "Ask your pharmacist if you are unsure"
}
],
"labels": {
"actions": "What to do",
"batches": "Affected batches"
},
"source": "Source: national medicines authority, notice of 12 November 2026, reference 2026-1187",
"cta": {
"label": "Check your pack",
"detail": "lindenhof-apotheken.example/recall"
},
"mandatory": "Cold relief syrup is a medicine. Always read the label. Ask your pharmacist for advice.",
"look": {
"logo": "auto",
"pace": "standard",
"align": "start",
"theme": "brand",
"corners": "square",
"logoSize": "auto"
}
},
"metaData": {
"title": "Product recall: cold relief syrup, 100 ml",
"captionTiny": "Product recall: cold relief syrup, 100 ml, batches CR24-1187, CR24-1188 and CR25-0042. Please stop using it and bring it to any member pharmacy.",
"captionShort": "Product recall: cold relief syrup, 100 ml. A laboratory check found that some bottles may hold less of the active ingredient than the label says. Affected batches: CR24-1187, CR24-1188 and CR25-0042. Please stop using the syrup from these batches and bring it to any member pharmacy for a free replacement. Source: national medicines authority, notice of 12 November 2026.",
"captionMedium": "Product recall: cold relief syrup, 100 ml, cherry flavour. A laboratory check found that some bottles may hold less of the active ingredient than the label says. Affected batches: CR24-1187 and CR24-1188 (expires 11/2027) and CR25-0042 (expires 02/2028). What to do: check the batch number on the label of your bottle; if it is one of these, please stop using the syrup and bring it to any member pharmacy for a free replacement; and ask your pharmacist if you are unsure. Source: national medicines authority, notice of 12 November 2026, reference 2026-1187. Cold relief syrup is a medicine. Always read the label. Ask your pharmacist for advice.",
"captionLong": "Product recall: cold relief syrup, 100 ml, cherry flavour, bottle with a white child-resistant cap. A laboratory check found that some bottles may hold less of the active ingredient than the label says. The maker is recalling the affected batches as a precaution, and so are we. Affected batches: CR24-1187 and CR24-1188 (expires 11/2027) and CR25-0042 (expires 02/2028). What to do: check the batch number printed on the label of your bottle. If it is one of these, please stop using the syrup from these batches and bring the bottle to any member pharmacy, where you will get a free replacement, with no receipt needed. If you are unsure which batch you have, or you have questions about your symptoms, ask your pharmacist: we are glad to help. Source: national medicines authority, notice of 12 November 2026, reference 2026-1187. Cold relief syrup is a medicine. Always read the label. Ask your pharmacist for advice.",
"hashtags": [
"pharmacy",
"recall",
"safetynotice",
"health"
]
}
}
}
The delivery names no version: which build draws it is the channel's choice, the newest of its
variant or the one it is pinned to. eventId is a ULID you make once per event: sending the same
one again changes nothing. occurredAt is when the thing happened, not when you sent it. locale
is the language of the text in data, and data.locales carries other languages beside it.