Public bodies, Roadworks 1.0.0
| Template | Public bodies, tpl_4f9a6b9f3068 |
|---|---|
| Variant | Roadworks |
| Version | 1.0.0, the newest: what a channel following this variant draws |
| Shapes | 9x16, 4x5, 1x1, 16x9, 2x3 |
| Length | 18 seconds |
Example video
The 1x1 cut of this version, drawn from its own worked example. Open the video on its own.
What it accepts
Roadworks or another disruption: where, when, how much it affects people, a map drawn from the closed section and its diversion or a picture of the site, how far the works are, one to five pieces of advice, and where to get help. The clip is as long as the advice needs. 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 works, where and when, the impact, the map or picture, the progress, the advice and where to get help. | |
clipData.kicker | text | up to 32 characters | Kicker: A short line above the headline, such as Roadworks or Water main repair. | |
clipData.headline | text | yes | up to 70 characters | Headline: What is happening, in one sentence. |
clipData.impact | enum | minor, moderate, major, closed | Impact: How much it affects people, which sets the colours and the meter: minor and moderate in the brand's colour, major and closed in its warning colour. Its name on screen is the impact label below. | |
clipData.impactLabel | text | up to 32 characters | Impact label: The impact in words, such as Closed to all traffic or Expect delays. | |
clipData.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: The symbol on the impact band. Without one, the impact's own. | |
clipData.place | text | up to 60 characters | Where: Where the works are. | |
clipData.date | text | up to 48 characters | When: The dates, as they should be read. | |
clipData.time | text | up to 40 characters | Time: The hours, where they matter. | |
clipData.section | group | Map: The closed or affected stretch, drawn as a small map: the road, the works between its two ends, and the diversion around them. | ||
clipData.section.from | text | up to 24 characters | From: Where the works begin, such as a junction. | |
clipData.section.to | text | up to 24 characters | To: Where they end. | |
clipData.section.via | text | up to 32 characters | Diversion: The way round, written on the diversion. Leave it out where there is none. | |
clipData.progress | number | from 0, to 100, 0 decimals | Progress: How far the works are, in percent from 0 to 100. Shown only where sent. | |
clipData.progressLabel | text | up to 32 characters | Progress label: What the percentage means, such as Works complete. | |
clipData.picture | image | media:// file from the media library, alt text up to 120 characters | Picture: A photo of the site or a map, any shape. Without one, the cover shows the map drawn from the stretch above. | |
clipData.adviceTitle | text | up to 32 characters | Title over the advice: A short title over the advice, such as Getting around. | |
clipData.advice | list | at least 1, up to 5 | Advice: One to five things to know or do: the diversion, buses, foot and cycle paths, extra time. Shown one after another and left on screen; the clip gets about two seconds longer for each. | |
clipData.advice[] | group | Advice | ||
clipData.advice[].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 symbol for it. An arrow where none is chosen. | |
clipData.advice[].text | text | yes | up to 70 characters | Advice: In a short sentence. |
clipData.help | group | Where to get help: Where people turn with questions: a help line, a desk, a web page. | ||
clipData.help.label | text | up to 40 characters | What it is: What the help is, such as Roadworks line or Travel information. | |
clipData.help.detail | text | up to 40 characters | Number or address: The number to call or the address to go to, drawn large. | |
clipData.help.note | text | up to 64 characters | Line under it: When it is open, a web address, anything else to know. | |
clipData.help.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: The symbol on the card. A phone where none is chosen. | |
clipData.disclaimer | text | up to 120 characters | Small print: Anything that must be said with the works, shown at the foot. | |
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.stripes | boolean | Barrier stripes: Diagonal barrier stripes on the impact band and on the works in the map. Off for a quieter look. | ||
clipData.look.pictureFit | enum | fill, whole | Picture: Fill: the picture fills its frame and is cropped, for a photo. Whole: all of it is shown, for a map or a plan. | |
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 headline, such as Roadworks or Water main repair."
},
"headline": {
"type": "string",
"maxLength": 70,
"title": "Headline",
"description": "What is happening, in one sentence."
},
"impact": {
"type": "string",
"enum": [
"minor",
"moderate",
"major",
"closed"
],
"title": "Impact",
"description": "How much it affects people, which sets the colours and the meter: minor and moderate in the brand's colour, major and closed in its warning colour. Its name on screen is the impact label below.",
"enumNames": [
"Minor",
"Moderate",
"Major",
"Closed"
]
},
"impactLabel": {
"type": "string",
"maxLength": 32,
"title": "Impact label",
"description": "The impact in words, such as Closed to all traffic or Expect delays."
},
"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": "The symbol on the impact band. Without one, the impact's own.",
"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"
]
},
"place": {
"type": "string",
"maxLength": 60,
"title": "Where",
"description": "Where the works are."
},
"date": {
"type": "string",
"maxLength": 48,
"title": "When",
"description": "The dates, as they should be read."
},
"time": {
"type": "string",
"maxLength": 40,
"title": "Time",
"description": "The hours, where they matter."
},
"section": {
"type": "object",
"properties": {
"from": {
"type": "string",
"maxLength": 24,
"title": "From",
"description": "Where the works begin, such as a junction."
},
"to": {
"type": "string",
"maxLength": 24,
"title": "To",
"description": "Where they end."
},
"via": {
"type": "string",
"maxLength": 32,
"title": "Diversion",
"description": "The way round, written on the diversion. Leave it out where there is none."
}
},
"additionalProperties": false,
"title": "Map",
"description": "The closed or affected stretch, drawn as a small map: the road, the works between its two ends, and the diversion around them."
},
"progress": {
"type": "number",
"minimum": 0,
"maximum": 100,
"title": "Progress",
"description": "How far the works are, in percent from 0 to 100. Shown only where sent."
},
"progressLabel": {
"type": "string",
"maxLength": 32,
"title": "Progress label",
"description": "What the percentage means, such as Works complete."
},
"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": "A photo of the site or a map, any shape. Without one, the cover shows the map drawn from the stretch above."
},
"adviceTitle": {
"type": "string",
"maxLength": 32,
"title": "Title over the advice",
"description": "A short title over the advice, such as Getting around."
},
"advice": {
"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 symbol for it. An arrow where none is chosen.",
"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"
]
},
"text": {
"type": "string",
"maxLength": 70,
"title": "Advice",
"description": "In a short sentence."
}
},
"required": [
"text"
],
"additionalProperties": false,
"title": "Advice"
},
"minItems": 1,
"maxItems": 5,
"title": "Advice",
"description": "One to five things to know or do: the diversion, buses, foot and cycle paths, extra time. Shown one after another and left on screen; the clip gets about two seconds longer for each."
},
"help": {
"type": "object",
"properties": {
"label": {
"type": "string",
"maxLength": 40,
"title": "What it is",
"description": "What the help is, such as Roadworks line or Travel information."
},
"detail": {
"type": "string",
"maxLength": 40,
"title": "Number or address",
"description": "The number to call or the address to go to, drawn large."
},
"note": {
"type": "string",
"maxLength": 64,
"title": "Line under it",
"description": "When it is open, a web address, anything else to know."
},
"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": "The symbol on the card. A phone where none is chosen.",
"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"
]
}
},
"additionalProperties": false,
"title": "Where to get help",
"description": "Where people turn with questions: a help line, a desk, a web page."
},
"disclaimer": {
"type": "string",
"maxLength": 120,
"title": "Small print",
"description": "Anything that must be said with the works, shown at the foot."
},
"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"
]
},
"stripes": {
"type": "boolean",
"title": "Barrier stripes",
"description": "Diagonal barrier stripes on the impact band and on the works in the map. Off for a quieter look."
},
"pictureFit": {
"type": "string",
"enum": [
"fill",
"whole"
],
"title": "Picture",
"description": "Fill: the picture fills its frame and is cropped, for a photo. Whole: all of it is shown, for a map or a plan.",
"enumNames": [
"Fill the frame",
"Show all of it"
]
},
"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"
],
"additionalProperties": false,
"title": "Clip data",
"description": "Everything drawn in the clip: the works, where and when, the impact, the map or picture, the progress, the advice and where to get help."
},
"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 headline, such as Roadworks or Water main repair."
},
"headline": {
"type": "string",
"maxLength": 70,
"title": "Headline",
"description": "What is happening, in one sentence."
},
"impact": {
"type": "string",
"enum": [
"minor",
"moderate",
"major",
"closed"
],
"title": "Impact",
"description": "How much it affects people, which sets the colours and the meter: minor and moderate in the brand's colour, major and closed in its warning colour. Its name on screen is the impact label below.",
"enumNames": [
"Minor",
"Moderate",
"Major",
"Closed"
]
},
"impactLabel": {
"type": "string",
"maxLength": 32,
"title": "Impact label",
"description": "The impact in words, such as Closed to all traffic or Expect delays."
},
"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": "The symbol on the impact band. Without one, the impact's own.",
"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"
]
},
"place": {
"type": "string",
"maxLength": 60,
"title": "Where",
"description": "Where the works are."
},
"date": {
"type": "string",
"maxLength": 48,
"title": "When",
"description": "The dates, as they should be read."
},
"time": {
"type": "string",
"maxLength": 40,
"title": "Time",
"description": "The hours, where they matter."
},
"section": {
"type": "object",
"properties": {
"from": {
"type": "string",
"maxLength": 24,
"title": "From",
"description": "Where the works begin, such as a junction."
},
"to": {
"type": "string",
"maxLength": 24,
"title": "To",
"description": "Where they end."
},
"via": {
"type": "string",
"maxLength": 32,
"title": "Diversion",
"description": "The way round, written on the diversion. Leave it out where there is none."
}
},
"additionalProperties": false,
"title": "Map",
"description": "The closed or affected stretch, drawn as a small map: the road, the works between its two ends, and the diversion around them."
},
"progress": {
"type": "number",
"minimum": 0,
"maximum": 100,
"title": "Progress",
"description": "How far the works are, in percent from 0 to 100. Shown only where sent."
},
"progressLabel": {
"type": "string",
"maxLength": 32,
"title": "Progress label",
"description": "What the percentage means, such as Works complete."
},
"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": "A photo of the site or a map, any shape. Without one, the cover shows the map drawn from the stretch above."
},
"adviceTitle": {
"type": "string",
"maxLength": 32,
"title": "Title over the advice",
"description": "A short title over the advice, such as Getting around."
},
"advice": {
"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 symbol for it. An arrow where none is chosen.",
"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"
]
},
"text": {
"type": "string",
"maxLength": 70,
"title": "Advice",
"description": "In a short sentence."
}
},
"required": [
"text"
],
"additionalProperties": false,
"title": "Advice"
},
"minItems": 1,
"maxItems": 5,
"title": "Advice",
"description": "One to five things to know or do: the diversion, buses, foot and cycle paths, extra time. Shown one after another and left on screen; the clip gets about two seconds longer for each."
},
"help": {
"type": "object",
"properties": {
"label": {
"type": "string",
"maxLength": 40,
"title": "What it is",
"description": "What the help is, such as Roadworks line or Travel information."
},
"detail": {
"type": "string",
"maxLength": 40,
"title": "Number or address",
"description": "The number to call or the address to go to, drawn large."
},
"note": {
"type": "string",
"maxLength": 64,
"title": "Line under it",
"description": "When it is open, a web address, anything else to know."
},
"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": "The symbol on the card. A phone where none is chosen.",
"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"
]
}
},
"additionalProperties": false,
"title": "Where to get help",
"description": "Where people turn with questions: a help line, a desk, a web page."
},
"disclaimer": {
"type": "string",
"maxLength": 120,
"title": "Small print",
"description": "Anything that must be said with the works, shown at the foot."
},
"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"
]
},
"stripes": {
"type": "boolean",
"title": "Barrier stripes",
"description": "Diagonal barrier stripes on the impact band and on the works in the map. Off for a quieter look."
},
"pictureFit": {
"type": "string",
"enum": [
"fill",
"whole"
],
"title": "Picture",
"description": "Fill: the picture fills its frame and is cropped, for a photo. Whole: all of it is shown, for a map or a plan.",
"enumNames": [
"Fill the frame",
"Show all of it"
]
},
"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 works, where and when, the impact, the map or picture, the progress, the advice and where to get help."
},
"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=Roadworks&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": "Roadworks",
"headline": "Bridge Street closed for resurfacing",
"impact": "closed",
"impactLabel": "Closed to all traffic",
"icon": "car",
"place": "Bridge Street, between Mill Lane and Market Square",
"date": "Monday 13 October to Friday 7 November",
"time": "Day and night, weekends included",
"section": {
"from": "Mill Lane",
"to": "Market Square",
"via": "Via Station Road"
},
"progress": 35,
"progressLabel": "Works complete",
"picture": {
"alt": "Soft waves of blue, violet and orange",
"url": "media://example-image.jpg"
},
"adviceTitle": "Getting around",
"advice": [
{
"icon": "car",
"text": "Drivers follow the yellow diversion signs via Station Road"
},
{
"icon": "bus",
"text": "Buses 4 and 7 stop at Mill Lane instead of Market Square"
},
{
"icon": "bike",
"text": "People on foot and on bikes can pass on both pavements"
},
{
"icon": "clock",
"text": "Allow ten extra minutes at peak times"
}
],
"help": {
"label": "Roadworks line",
"detail": "0800 555 0142",
"note": "Updates at westbrook.example/roadworks",
"icon": "phone"
},
"disclaimer": "Dates may change with the weather. Residents and emergency services have access at all times.",
"look": {
"theme": "brand",
"pace": "standard",
"corners": "soft",
"align": "start",
"stripes": true,
"pictureFit": "fill",
"logo": "auto"
}
},
"metaData": {
"title": "Bridge Street closed for resurfacing until 7 November",
"captionTiny": "Bridge Street is closed between Mill Lane and Market Square until 7 November. Diversion via Station Road.",
"captionShort": "Bridge Street is closed to all traffic between Mill Lane and Market Square from 13 October to 7 November while we resurface it. Follow the diversion via Station Road; buses 4 and 7 stop at Mill Lane. Updates at westbrook.example/roadworks.",
"captionMedium": "Bridge Street is closed to all traffic between Mill Lane and Market Square from Monday 13 October to Friday 7 November, day and night, while we resurface the road and renew the pavements. Drivers follow the yellow diversion signs via Station Road. Buses 4 and 7 stop at Mill Lane instead of Market Square. People on foot and on bikes can pass on both pavements. Allow ten extra minutes at peak times. Questions: roadworks line 0800 555 0142.",
"captionLong": "Bridge Street is closed to all traffic between Mill Lane and Market Square from Monday 13 October to Friday 7 November, day and night and at weekends, while we resurface the road and renew the pavements. The works are a third done. Drivers follow the yellow diversion signs via Station Road. Buses 4 and 7 stop at Mill Lane instead of Market Square for the whole time. People on foot and on bikes can pass on both pavements, and every shop stays open. Allow ten extra minutes at peak times. Residents and emergency services have access at all times. Dates may change with the weather; we post updates at westbrook.example/roadworks, and the roadworks line on 0800 555 0142 answers questions on weekdays.",
"hashtags": [
"roadworks",
"westbrook",
"bridgestreet",
"traffic"
]
}
}
}
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.