Public bodies, Consultation 1.0.0
| Template | Public bodies, tpl_4f9a6b9f3068 |
|---|---|
| Variant | Consultation |
| Version | 1.0.0, the newest: what a channel following this variant draws |
| Shapes | 9x16, 4x5, 1x1, 16x9, 2x3 |
| Length | 14 seconds |
Example video
The 1x1 cut of this version, drawn from its own worked example. Open the video on its own.
What it accepts
Have your say: a public consultation's question, one to six options with an icon each and, where they are sent, the results so far in percent, the deadline, the ways to take part and a call to action. The clip is as long as the options need. metaData is the post's title, descriptions and hashtags and is never drawn.
| Field | Type | Required | Limit | What it is |
|---|---|---|---|---|
clipData | group | yes | Clip data: Everything drawn in the clip: the question, its context and picture, the options and their results, the deadline and how to take part. | |
clipData.kicker | text | up to 32 characters | Kicker: A short line above the question, such as Have your say. | |
clipData.headline | text | yes | up to 90 characters | Question: The question you are asking, the way people should read it. |
clipData.subline | text | up to 140 characters | Context: One or two sentences on why you ask and who should answer. | |
clipData.picture | image | media:// file from the media library, alt text up to 120 characters | Picture: The place or the plan the question is about, any shape. Without one, the question stands on its own. | |
clipData.options | list | yes | at least 1, up to 6 | Options: One to six options, in the order they should be read; the clip gets a second and a third longer for each. |
clipData.options[] | group | Option | ||
clipData.options[].label | text | yes | up to 48 characters | Option: The option, in a few words. |
clipData.options[].detail | text | up to 60 characters | Detail: What it would mean, in one line. | |
clipData.options[].icon | enum | check, circle-check, x, arrow-right, arrow-up-right, plus, star, heart, thumbs-up, sparkles, zap, clock, calendar, map-pin, info, triangle-alert, lightbulb, target, award, crown, gem, flame, timer, list-checks, clipboard-check, badge-check, hand-heart, rocket, trophy, megaphone, bell, qr-code, ticket, gift, key-round, book-open, graduation-cap, house, phone, mail, globe, users, user, building, bus, train-front, bike, car, leaf, recycle, trees, file-text, thermometer, droplets, sun, cloud-rain, snowflake, wind, stethoscope, school, trash, accessibility, hand-helping | Icon: A line icon for the option. Without one, its number stands alone. | |
clipData.options[].result | number | from 0, to 100, 1 decimals | Result so far: The share of answers for this option, in percent, where you show results. Drawn exactly as sent. | |
clipData.resultsNote | text | up to 60 characters | About the results: What the results are, such as Interim results from 1,248 answers. Shown with the results only. | |
clipData.deadline | text | up to 48 characters | Deadline: Until when people can take part, as it should be read. | |
clipData.ways | list | at least 1, up to 4 | Ways to take part: One to four ways to answer, each with an icon: online, in person, by post. | |
clipData.ways[] | group | Way | ||
clipData.ways[].icon | enum | check, circle-check, x, arrow-right, arrow-up-right, plus, star, heart, thumbs-up, sparkles, zap, clock, calendar, map-pin, info, triangle-alert, lightbulb, target, award, crown, gem, flame, timer, list-checks, clipboard-check, badge-check, hand-heart, rocket, trophy, megaphone, bell, qr-code, ticket, gift, key-round, book-open, graduation-cap, house, phone, mail, globe, users, user, building, bus, train-front, bike, car, leaf, recycle, trees, file-text, thermometer, droplets, sun, cloud-rain, snowflake, wind, stethoscope, school, trash, accessibility, hand-helping | Icon: A line icon for this way. | |
clipData.ways[].label | text | yes | up to 40 characters | How: The way to take part. |
clipData.ways[].detail | text | up to 56 characters | Where and when: An address, a time, a phone number. | |
clipData.cta | group | Call to action: The button at the end and the line under it, such as a web address, a handle 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: An address, a handle, a phone number. | |
clipData.disclaimer | text | up to 120 characters | Small print: Notes that must be shown, such as how answers are used. | |
clipData.look | group | Look: How the clip looks and moves. The same five switches in every format (theme, pace, corners, alignment, logo), plus this format's own. Leave any out for the format's default. | ||
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.layout | enum | ballot, cards | Layout: Ballot: the options as lines on a ballot, with bars. Cards: the options as tiles that fill up with their result. | |
clipData.look.showResults | boolean | Show the results: Bars with each option's result, where results are sent. | ||
clipData.look.logo | enum | auto, free | Logo: The style's own: the logo on the style's plate (a card, a disc, a badge) 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. | |
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 422 that
names the field.
The JSON Schema
{
"type": "object",
"properties": {
"clipData": {
"type": "object",
"properties": {
"kicker": {
"type": "string",
"maxLength": 32,
"title": "Kicker",
"description": "A short line above the question, such as Have your say."
},
"headline": {
"type": "string",
"maxLength": 90,
"title": "Question",
"description": "The question you are asking, the way people should read it."
},
"subline": {
"type": "string",
"maxLength": 140,
"title": "Context",
"description": "One or two sentences on why you ask and who should answer."
},
"picture": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048,
"pattern": "^media:\\/\\/[^\\s/\\\\\\u0000-\\u001f][^/\\\\\\u0000-\\u001f]{0,254}$",
"title": "Picture",
"description": "A file from the workspace's media library, written media:// and the file's id or name. A web address is refused."
},
"alt": {
"type": "string",
"maxLength": 120,
"title": "Alt text",
"description": "What the picture shows, for anyone who cannot see it."
}
},
"required": [
"url"
],
"additionalProperties": false,
"title": "Picture",
"description": "The place or the plan the question is about, any shape. Without one, the question stands on its own."
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"maxLength": 48,
"title": "Option",
"description": "The option, in a few words."
},
"detail": {
"type": "string",
"maxLength": 60,
"title": "Detail",
"description": "What it would mean, in one line."
},
"icon": {
"type": "string",
"enum": [
"check",
"circle-check",
"x",
"arrow-right",
"arrow-up-right",
"plus",
"star",
"heart",
"thumbs-up",
"sparkles",
"zap",
"clock",
"calendar",
"map-pin",
"info",
"triangle-alert",
"lightbulb",
"target",
"award",
"crown",
"gem",
"flame",
"timer",
"list-checks",
"clipboard-check",
"badge-check",
"hand-heart",
"rocket",
"trophy",
"megaphone",
"bell",
"qr-code",
"ticket",
"gift",
"key-round",
"book-open",
"graduation-cap",
"house",
"phone",
"mail",
"globe",
"users",
"user",
"building",
"bus",
"train-front",
"bike",
"car",
"leaf",
"recycle",
"trees",
"file-text",
"thermometer",
"droplets",
"sun",
"cloud-rain",
"snowflake",
"wind",
"stethoscope",
"school",
"trash",
"accessibility",
"hand-helping"
],
"title": "Icon",
"description": "A line icon for the option. Without one, its number stands alone.",
"enumNames": [
"Check",
"Circle check",
"X",
"Arrow right",
"Arrow up right",
"Plus",
"Star",
"Heart",
"Thumbs up",
"Sparkles",
"Zap",
"Clock",
"Calendar",
"Map pin",
"Info",
"Triangle alert",
"Lightbulb",
"Target",
"Award",
"Crown",
"Gem",
"Flame",
"Timer",
"List checks",
"Clipboard check",
"Badge check",
"Hand heart",
"Rocket",
"Trophy",
"Megaphone",
"Bell",
"Qr code",
"Ticket",
"Gift",
"Key round",
"Book open",
"Graduation cap",
"House",
"Phone",
"Mail",
"Globe",
"Users",
"User",
"Building",
"Bus",
"Train front",
"Bike",
"Car",
"Leaf",
"Recycle",
"Trees",
"File text",
"Thermometer",
"Droplets",
"Sun",
"Cloud rain",
"Snowflake",
"Wind",
"Stethoscope",
"School",
"Trash",
"Accessibility",
"Hand helping"
]
},
"result": {
"type": "number",
"minimum": 0,
"maximum": 100,
"title": "Result so far",
"description": "The share of answers for this option, in percent, where you show results. Drawn exactly as sent."
}
},
"required": [
"label"
],
"additionalProperties": false,
"title": "Option"
},
"minItems": 1,
"maxItems": 6,
"title": "Options",
"description": "One to six options, in the order they should be read; the clip gets a second and a third longer for each."
},
"resultsNote": {
"type": "string",
"maxLength": 60,
"title": "About the results",
"description": "What the results are, such as Interim results from 1,248 answers. Shown with the results only."
},
"deadline": {
"type": "string",
"maxLength": 48,
"title": "Deadline",
"description": "Until when people can take part, as it should be read."
},
"ways": {
"type": "array",
"items": {
"type": "object",
"properties": {
"icon": {
"type": "string",
"enum": [
"check",
"circle-check",
"x",
"arrow-right",
"arrow-up-right",
"plus",
"star",
"heart",
"thumbs-up",
"sparkles",
"zap",
"clock",
"calendar",
"map-pin",
"info",
"triangle-alert",
"lightbulb",
"target",
"award",
"crown",
"gem",
"flame",
"timer",
"list-checks",
"clipboard-check",
"badge-check",
"hand-heart",
"rocket",
"trophy",
"megaphone",
"bell",
"qr-code",
"ticket",
"gift",
"key-round",
"book-open",
"graduation-cap",
"house",
"phone",
"mail",
"globe",
"users",
"user",
"building",
"bus",
"train-front",
"bike",
"car",
"leaf",
"recycle",
"trees",
"file-text",
"thermometer",
"droplets",
"sun",
"cloud-rain",
"snowflake",
"wind",
"stethoscope",
"school",
"trash",
"accessibility",
"hand-helping"
],
"title": "Icon",
"description": "A line icon for this way.",
"enumNames": [
"Check",
"Circle check",
"X",
"Arrow right",
"Arrow up right",
"Plus",
"Star",
"Heart",
"Thumbs up",
"Sparkles",
"Zap",
"Clock",
"Calendar",
"Map pin",
"Info",
"Triangle alert",
"Lightbulb",
"Target",
"Award",
"Crown",
"Gem",
"Flame",
"Timer",
"List checks",
"Clipboard check",
"Badge check",
"Hand heart",
"Rocket",
"Trophy",
"Megaphone",
"Bell",
"Qr code",
"Ticket",
"Gift",
"Key round",
"Book open",
"Graduation cap",
"House",
"Phone",
"Mail",
"Globe",
"Users",
"User",
"Building",
"Bus",
"Train front",
"Bike",
"Car",
"Leaf",
"Recycle",
"Trees",
"File text",
"Thermometer",
"Droplets",
"Sun",
"Cloud rain",
"Snowflake",
"Wind",
"Stethoscope",
"School",
"Trash",
"Accessibility",
"Hand helping"
]
},
"label": {
"type": "string",
"maxLength": 40,
"title": "How",
"description": "The way to take part."
},
"detail": {
"type": "string",
"maxLength": 56,
"title": "Where and when",
"description": "An address, a time, a phone number."
}
},
"required": [
"label"
],
"additionalProperties": false,
"title": "Way"
},
"minItems": 1,
"maxItems": 4,
"title": "Ways to take part",
"description": "One to four ways to answer, each with an icon: online, in person, by post."
},
"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": "An address, a handle, 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, a handle or a phone number."
},
"disclaimer": {
"type": "string",
"maxLength": 120,
"title": "Small print",
"description": "Notes that must be shown, such as how answers are used."
},
"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"
]
},
"layout": {
"type": "string",
"enum": [
"ballot",
"cards"
],
"title": "Layout",
"description": "Ballot: the options as lines on a ballot, with bars. Cards: the options as tiles that fill up with their result.",
"enumNames": [
"Ballot lines",
"Cards"
]
},
"showResults": {
"type": "boolean",
"title": "Show the results",
"description": "Bars with each option's result, where results are sent."
},
"logo": {
"type": "string",
"enum": [
"auto",
"free"
],
"title": "Logo",
"description": "The style's own: the logo on the style's plate (a card, a disc, a badge) 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"
]
}
},
"additionalProperties": false,
"title": "Look",
"description": "How the clip looks and moves. The same five switches in every format (theme, pace, corners, alignment, logo), plus this format's own. Leave any out for the format's default."
}
},
"required": [
"headline",
"options"
],
"additionalProperties": false,
"title": "Clip data",
"description": "Everything drawn in the clip: the question, its context and picture, the options and their results, the deadline and how to take part."
},
"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": {
"kicker": {
"type": "string",
"maxLength": 32,
"title": "Kicker",
"description": "A short line above the question, such as Have your say."
},
"headline": {
"type": "string",
"maxLength": 90,
"title": "Question",
"description": "The question you are asking, the way people should read it."
},
"subline": {
"type": "string",
"maxLength": 140,
"title": "Context",
"description": "One or two sentences on why you ask and who should answer."
},
"picture": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048,
"pattern": "^media:\\/\\/[^\\s/\\\\\\u0000-\\u001f][^/\\\\\\u0000-\\u001f]{0,254}$",
"title": "Picture",
"description": "A file from the workspace's media library, written media:// and the file's id or name. A web address is refused."
},
"alt": {
"type": "string",
"maxLength": 120,
"title": "Alt text",
"description": "What the picture shows, for anyone who cannot see it."
}
},
"required": [
"url"
],
"additionalProperties": false,
"title": "Picture",
"description": "The place or the plan the question is about, any shape. Without one, the question stands on its own."
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"maxLength": 48,
"title": "Option",
"description": "The option, in a few words."
},
"detail": {
"type": "string",
"maxLength": 60,
"title": "Detail",
"description": "What it would mean, in one line."
},
"icon": {
"type": "string",
"enum": [
"check",
"circle-check",
"x",
"arrow-right",
"arrow-up-right",
"plus",
"star",
"heart",
"thumbs-up",
"sparkles",
"zap",
"clock",
"calendar",
"map-pin",
"info",
"triangle-alert",
"lightbulb",
"target",
"award",
"crown",
"gem",
"flame",
"timer",
"list-checks",
"clipboard-check",
"badge-check",
"hand-heart",
"rocket",
"trophy",
"megaphone",
"bell",
"qr-code",
"ticket",
"gift",
"key-round",
"book-open",
"graduation-cap",
"house",
"phone",
"mail",
"globe",
"users",
"user",
"building",
"bus",
"train-front",
"bike",
"car",
"leaf",
"recycle",
"trees",
"file-text",
"thermometer",
"droplets",
"sun",
"cloud-rain",
"snowflake",
"wind",
"stethoscope",
"school",
"trash",
"accessibility",
"hand-helping"
],
"title": "Icon",
"description": "A line icon for the option. Without one, its number stands alone.",
"enumNames": [
"Check",
"Circle check",
"X",
"Arrow right",
"Arrow up right",
"Plus",
"Star",
"Heart",
"Thumbs up",
"Sparkles",
"Zap",
"Clock",
"Calendar",
"Map pin",
"Info",
"Triangle alert",
"Lightbulb",
"Target",
"Award",
"Crown",
"Gem",
"Flame",
"Timer",
"List checks",
"Clipboard check",
"Badge check",
"Hand heart",
"Rocket",
"Trophy",
"Megaphone",
"Bell",
"Qr code",
"Ticket",
"Gift",
"Key round",
"Book open",
"Graduation cap",
"House",
"Phone",
"Mail",
"Globe",
"Users",
"User",
"Building",
"Bus",
"Train front",
"Bike",
"Car",
"Leaf",
"Recycle",
"Trees",
"File text",
"Thermometer",
"Droplets",
"Sun",
"Cloud rain",
"Snowflake",
"Wind",
"Stethoscope",
"School",
"Trash",
"Accessibility",
"Hand helping"
]
},
"result": {
"type": "number",
"minimum": 0,
"maximum": 100,
"title": "Result so far",
"description": "The share of answers for this option, in percent, where you show results. Drawn exactly as sent."
}
},
"required": [
"label"
],
"additionalProperties": false,
"title": "Option"
},
"minItems": 1,
"maxItems": 6,
"title": "Options",
"description": "One to six options, in the order they should be read; the clip gets a second and a third longer for each."
},
"resultsNote": {
"type": "string",
"maxLength": 60,
"title": "About the results",
"description": "What the results are, such as Interim results from 1,248 answers. Shown with the results only."
},
"deadline": {
"type": "string",
"maxLength": 48,
"title": "Deadline",
"description": "Until when people can take part, as it should be read."
},
"ways": {
"type": "array",
"items": {
"type": "object",
"properties": {
"icon": {
"type": "string",
"enum": [
"check",
"circle-check",
"x",
"arrow-right",
"arrow-up-right",
"plus",
"star",
"heart",
"thumbs-up",
"sparkles",
"zap",
"clock",
"calendar",
"map-pin",
"info",
"triangle-alert",
"lightbulb",
"target",
"award",
"crown",
"gem",
"flame",
"timer",
"list-checks",
"clipboard-check",
"badge-check",
"hand-heart",
"rocket",
"trophy",
"megaphone",
"bell",
"qr-code",
"ticket",
"gift",
"key-round",
"book-open",
"graduation-cap",
"house",
"phone",
"mail",
"globe",
"users",
"user",
"building",
"bus",
"train-front",
"bike",
"car",
"leaf",
"recycle",
"trees",
"file-text",
"thermometer",
"droplets",
"sun",
"cloud-rain",
"snowflake",
"wind",
"stethoscope",
"school",
"trash",
"accessibility",
"hand-helping"
],
"title": "Icon",
"description": "A line icon for this way.",
"enumNames": [
"Check",
"Circle check",
"X",
"Arrow right",
"Arrow up right",
"Plus",
"Star",
"Heart",
"Thumbs up",
"Sparkles",
"Zap",
"Clock",
"Calendar",
"Map pin",
"Info",
"Triangle alert",
"Lightbulb",
"Target",
"Award",
"Crown",
"Gem",
"Flame",
"Timer",
"List checks",
"Clipboard check",
"Badge check",
"Hand heart",
"Rocket",
"Trophy",
"Megaphone",
"Bell",
"Qr code",
"Ticket",
"Gift",
"Key round",
"Book open",
"Graduation cap",
"House",
"Phone",
"Mail",
"Globe",
"Users",
"User",
"Building",
"Bus",
"Train front",
"Bike",
"Car",
"Leaf",
"Recycle",
"Trees",
"File text",
"Thermometer",
"Droplets",
"Sun",
"Cloud rain",
"Snowflake",
"Wind",
"Stethoscope",
"School",
"Trash",
"Accessibility",
"Hand helping"
]
},
"label": {
"type": "string",
"maxLength": 40,
"title": "How",
"description": "The way to take part."
},
"detail": {
"type": "string",
"maxLength": 56,
"title": "Where and when",
"description": "An address, a time, a phone number."
}
},
"required": [
"label"
],
"additionalProperties": false,
"title": "Way"
},
"minItems": 1,
"maxItems": 4,
"title": "Ways to take part",
"description": "One to four ways to answer, each with an icon: online, in person, by post."
},
"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": "An address, a handle, 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, a handle or a phone number."
},
"disclaimer": {
"type": "string",
"maxLength": 120,
"title": "Small print",
"description": "Notes that must be shown, such as how answers are used."
},
"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"
]
},
"layout": {
"type": "string",
"enum": [
"ballot",
"cards"
],
"title": "Layout",
"description": "Ballot: the options as lines on a ballot, with bars. Cards: the options as tiles that fill up with their result.",
"enumNames": [
"Ballot lines",
"Cards"
]
},
"showResults": {
"type": "boolean",
"title": "Show the results",
"description": "Bars with each option's result, where results are sent."
},
"logo": {
"type": "string",
"enum": [
"auto",
"free"
],
"title": "Logo",
"description": "The style's own: the logo on the style's plate (a card, a disc, a badge) 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"
]
}
},
"additionalProperties": false,
"title": "Look",
"description": "How the clip looks and moves. The same five switches in every format (theme, pace, corners, alignment, logo), plus this format's own. Leave any out for the format's default."
}
},
"additionalProperties": false,
"title": "Clip data",
"description": "Everything drawn in the clip: the question, its context and picture, the options and their results, the deadline and how to take part."
},
"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_4f9a6b9f3068?variant=Consultation&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": {
"kicker": "Have your say on Mill Street",
"headline": "The old tram depot on Mill Street is closing. What should the site become?",
"subline": "Four plans are on the table. Tell us which one you prefer, whether you live, work or study nearby.",
"picture": {
"alt": "Soft waves of blue, violet and orange",
"url": "media://example-image.jpg"
},
"options": [
{
"icon": "trees",
"label": "A park with play areas and trees",
"detail": "Green space for the whole district",
"result": 38
},
{
"icon": "house",
"label": "Affordable homes for 120 families",
"detail": "Built with the city's housing trust",
"result": 27
},
{
"icon": "users",
"label": "A sports hall and a youth centre",
"detail": "Open seven days a week, all year round",
"result": 21
},
{
"icon": "leaf",
"label": "Homes around a smaller park",
"detail": "Half the site for each, with a cycle route",
"result": 14
}
],
"resultsNote": "Interim results from 1,248 answers so far",
"deadline": "Open until Friday 14 November",
"ways": [
{
"icon": "globe",
"label": "Online survey, about ten minutes",
"detail": "westbrook.example/depot"
},
{
"icon": "building",
"label": "Exhibition at the Town Hall",
"detail": "Weekdays 9:00 to 17:00, ground floor"
},
{
"icon": "users",
"label": "Drop-in evening with the planners",
"detail": "Thursday 23 October, 18:00, Mill Street library"
}
],
"cta": {
"label": "Take the survey",
"detail": "westbrook.example/depot"
},
"disclaimer": "Results so far are not weighted and may change. Your answers are anonymous and used only for this consultation.",
"look": {
"theme": "brand",
"pace": "standard",
"corners": "soft",
"align": "start",
"layout": "ballot",
"showResults": true,
"logo": "auto"
}
},
"metaData": {
"title": "Have your say: the future of the Mill Street tram depot",
"captionTiny": "The Mill Street tram depot is closing. A park, homes, a sports hall or a mix? Have your say until Friday 14 November.",
"captionShort": "The old tram depot on Mill Street is closing, and four plans are on the table: a park, affordable homes, a sports hall and youth centre, or homes around a smaller park. Tell us which you prefer online, at the Town Hall exhibition or at the drop-in evening. Open until Friday 14 November.",
"captionMedium": "The old tram depot on Mill Street is closing, and the city wants to know what the site should become. Four plans are on the table: a park with play areas and trees, affordable homes for 120 families, a sports hall and youth centre open all week, or homes around a smaller park with a cycle route. Interim results show the park ahead, but nothing is decided. Take the ten-minute survey online, visit the exhibition at the Town Hall on weekdays, or meet the planners at the drop-in evening at Mill Street library on Thursday 23 October. The consultation is open until Friday 14 November.",
"captionLong": "The old tram depot on Mill Street is closing next year, and the City of Westbrook wants to hear from everybody who lives, works or studies nearby about what the site should become. Four plans are on the table: a park with play areas and trees, affordable homes for 120 families built with the city's housing trust, a sports hall and youth centre open seven days a week, or homes around a smaller park with a new cycle route. Interim results from the first 1,248 answers show the park ahead, but they are not weighted and nothing is decided yet. Take the ten-minute survey online, visit the exhibition on the ground floor of the Town Hall on weekdays from 9:00 to 17:00, or meet the planners at the drop-in evening at Mill Street library on Thursday 23 October at 18:00. Your answers are anonymous. The consultation is open until Friday 14 November.",
"hashtags": [
"haveyoursay",
"westbrook",
"millstreet",
"consultation"
]
}
}
}
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.