Public bodies, How to apply 1.0.0
| Template | Public bodies, tpl_4f9a6b9f3068 |
|---|---|
| Variant | How to apply |
| Version | 1.0.0, the newest: what a channel following this variant draws |
| Shapes | 9x16, 4x5, 1x1, 16x9, 2x3 |
| Length | 17 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 guide to one public service: what to bring, the steps to apply, where and when to go, what it costs and where to get help, ending on the call to action. The clip gets longer with every step. 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 headline, the documents to bring, the steps, the place and opening times, the fees, the help line and the call to action. | |
clipData.kicker | text | up to 32 characters | Kicker: A short line above the headline, such as the service or the department. | |
clipData.headline | text | yes | up to 60 characters | Headline: Which service this guide is for. |
clipData.subline | text | up to 110 characters | Subline: One or two sentences under the headline: how long it takes, who it is for. | |
clipData.labels | group | Section titles: The titles of the guide's sections, in your words and language. A section without a title is shown without one. | ||
clipData.labels.documents | text | up to 28 characters | Documents: Above the list of what to bring. | |
clipData.labels.steps | text | up to 28 characters | Steps: Above the steps. | |
clipData.labels.visit | text | up to 28 characters | Where and when: Above the place and the opening times. | |
clipData.labels.fees | text | up to 28 characters | Fees: Above the fees. | |
clipData.documents | list | at least 1, up to 8 | What you need: One to eight documents or things to have ready, ticked off one by one. | |
clipData.documents[] | group | Document | ||
clipData.documents[].name | text | yes | up to 40 characters | Document: What it is. |
clipData.documents[].detail | text | up to 60 characters | Detail: Which ones count, how recent, how many. | |
clipData.documents[].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 it. Left out, a document. | |
clipData.steps | list | yes | at least 1, up to 6 | Steps: One to six steps, shown in order; the clip gets a second and two thirds longer for each. |
clipData.steps[] | group | Step | ||
clipData.steps[].title | text | yes | up to 40 characters | Step: What to do, in a few words. |
clipData.steps[].detail | text | up to 90 characters | Detail: How, in a sentence. | |
clipData.steps[].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 step, shown where the steps are marked by icons. | |
clipData.place | text | up to 64 characters | Where: Where to go in person. | |
clipData.time | text | up to 64 characters | When: Opening hours or appointment times. | |
clipData.picture | image | media:// file from the media library, alt text up to 120 characters | Picture: The place, such as the building or the counter; any shape. Left out, the place is shown without a picture. | |
clipData.currency | text | up to 3 characters | Currency: The ISO code the fees are in, such as EUR, GBP, USD or CHF. | |
clipData.fees | list | at least 1, up to 4 | Fees: One to four fees, each with what it is for and the amount. | |
clipData.fees[] | group | Fee | ||
clipData.fees[].label | text | yes | up to 40 characters | For: What the fee is for. |
clipData.fees[].amount | number | yes | from 0, 2 decimals | Amount: The fee, exactly as it is charged. |
clipData.help | text | up to 90 characters | Help: Where to get help: a phone number, an address, a chat. | |
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: Terms that must be shown with the guide. | |
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.stepLayout | enum | path, cards | Steps: Path: every step on one path, lit in turn. Cards: one large step after another. | |
clipData.look.marker | enum | numbers, icons | Step markers: How each step is marked: its number, or its icon. | |
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 the service or the department."
},
"headline": {
"type": "string",
"maxLength": 60,
"title": "Headline",
"description": "Which service this guide is for."
},
"subline": {
"type": "string",
"maxLength": 110,
"title": "Subline",
"description": "One or two sentences under the headline: how long it takes, who it is for."
},
"labels": {
"type": "object",
"properties": {
"documents": {
"type": "string",
"maxLength": 28,
"title": "Documents",
"description": "Above the list of what to bring."
},
"steps": {
"type": "string",
"maxLength": 28,
"title": "Steps",
"description": "Above the steps."
},
"visit": {
"type": "string",
"maxLength": 28,
"title": "Where and when",
"description": "Above the place and the opening times."
},
"fees": {
"type": "string",
"maxLength": 28,
"title": "Fees",
"description": "Above the fees."
}
},
"additionalProperties": false,
"title": "Section titles",
"description": "The titles of the guide's sections, in your words and language. A section without a title is shown without one."
},
"documents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 40,
"title": "Document",
"description": "What it is."
},
"detail": {
"type": "string",
"maxLength": 60,
"title": "Detail",
"description": "Which ones count, how recent, how many."
},
"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 it. Left out, a document.",
"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"
]
}
},
"required": [
"name"
],
"additionalProperties": false,
"title": "Document"
},
"minItems": 1,
"maxItems": 8,
"title": "What you need",
"description": "One to eight documents or things to have ready, ticked off one by one."
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 40,
"title": "Step",
"description": "What to do, in a few words."
},
"detail": {
"type": "string",
"maxLength": 90,
"title": "Detail",
"description": "How, in a sentence."
},
"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 step, shown where the steps are marked by icons.",
"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"
]
}
},
"required": [
"title"
],
"additionalProperties": false,
"title": "Step"
},
"minItems": 1,
"maxItems": 6,
"title": "Steps",
"description": "One to six steps, shown in order; the clip gets a second and two thirds longer for each."
},
"place": {
"type": "string",
"maxLength": 64,
"title": "Where",
"description": "Where to go in person."
},
"time": {
"type": "string",
"maxLength": 64,
"title": "When",
"description": "Opening hours or appointment times."
},
"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, such as the building or the counter; any shape. Left out, the place is shown without a picture."
},
"currency": {
"type": "string",
"maxLength": 3,
"title": "Currency",
"description": "The ISO code the fees are in, such as EUR, GBP, USD or CHF."
},
"fees": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"maxLength": 40,
"title": "For",
"description": "What the fee is for."
},
"amount": {
"type": "number",
"minimum": 0,
"title": "Amount",
"description": "The fee, exactly as it is charged."
}
},
"required": [
"label",
"amount"
],
"additionalProperties": false,
"title": "Fee"
},
"minItems": 1,
"maxItems": 4,
"title": "Fees",
"description": "One to four fees, each with what it is for and the amount."
},
"help": {
"type": "string",
"maxLength": 90,
"title": "Help",
"description": "Where to get help: a phone number, an address, a chat."
},
"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": "Terms that must be shown with the guide."
},
"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"
]
},
"stepLayout": {
"type": "string",
"enum": [
"path",
"cards"
],
"title": "Steps",
"description": "Path: every step on one path, lit in turn. Cards: one large step after another.",
"enumNames": [
"On one path",
"One card per step"
]
},
"marker": {
"type": "string",
"enum": [
"numbers",
"icons"
],
"title": "Step markers",
"description": "How each step is marked: its number, or its icon.",
"enumNames": [
"Numbers",
"Icons"
]
},
"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",
"steps"
],
"additionalProperties": false,
"title": "Clip data",
"description": "Everything drawn in the clip: the headline, the documents to bring, the steps, the place and opening times, the fees, the help line and the call to action."
},
"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 the service or the department."
},
"headline": {
"type": "string",
"maxLength": 60,
"title": "Headline",
"description": "Which service this guide is for."
},
"subline": {
"type": "string",
"maxLength": 110,
"title": "Subline",
"description": "One or two sentences under the headline: how long it takes, who it is for."
},
"labels": {
"type": "object",
"properties": {
"documents": {
"type": "string",
"maxLength": 28,
"title": "Documents",
"description": "Above the list of what to bring."
},
"steps": {
"type": "string",
"maxLength": 28,
"title": "Steps",
"description": "Above the steps."
},
"visit": {
"type": "string",
"maxLength": 28,
"title": "Where and when",
"description": "Above the place and the opening times."
},
"fees": {
"type": "string",
"maxLength": 28,
"title": "Fees",
"description": "Above the fees."
}
},
"additionalProperties": false,
"title": "Section titles",
"description": "The titles of the guide's sections, in your words and language. A section without a title is shown without one."
},
"documents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 40,
"title": "Document",
"description": "What it is."
},
"detail": {
"type": "string",
"maxLength": 60,
"title": "Detail",
"description": "Which ones count, how recent, how many."
},
"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 it. Left out, a document.",
"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"
]
}
},
"required": [
"name"
],
"additionalProperties": false,
"title": "Document"
},
"minItems": 1,
"maxItems": 8,
"title": "What you need",
"description": "One to eight documents or things to have ready, ticked off one by one."
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 40,
"title": "Step",
"description": "What to do, in a few words."
},
"detail": {
"type": "string",
"maxLength": 90,
"title": "Detail",
"description": "How, in a sentence."
},
"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 step, shown where the steps are marked by icons.",
"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"
]
}
},
"required": [
"title"
],
"additionalProperties": false,
"title": "Step"
},
"minItems": 1,
"maxItems": 6,
"title": "Steps",
"description": "One to six steps, shown in order; the clip gets a second and two thirds longer for each."
},
"place": {
"type": "string",
"maxLength": 64,
"title": "Where",
"description": "Where to go in person."
},
"time": {
"type": "string",
"maxLength": 64,
"title": "When",
"description": "Opening hours or appointment times."
},
"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, such as the building or the counter; any shape. Left out, the place is shown without a picture."
},
"currency": {
"type": "string",
"maxLength": 3,
"title": "Currency",
"description": "The ISO code the fees are in, such as EUR, GBP, USD or CHF."
},
"fees": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"maxLength": 40,
"title": "For",
"description": "What the fee is for."
},
"amount": {
"type": "number",
"minimum": 0,
"title": "Amount",
"description": "The fee, exactly as it is charged."
}
},
"required": [
"label",
"amount"
],
"additionalProperties": false,
"title": "Fee"
},
"minItems": 1,
"maxItems": 4,
"title": "Fees",
"description": "One to four fees, each with what it is for and the amount."
},
"help": {
"type": "string",
"maxLength": 90,
"title": "Help",
"description": "Where to get help: a phone number, an address, a chat."
},
"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": "Terms that must be shown with the guide."
},
"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"
]
},
"stepLayout": {
"type": "string",
"enum": [
"path",
"cards"
],
"title": "Steps",
"description": "Path: every step on one path, lit in turn. Cards: one large step after another.",
"enumNames": [
"On one path",
"One card per step"
]
},
"marker": {
"type": "string",
"enum": [
"numbers",
"icons"
],
"title": "Step markers",
"description": "How each step is marked: its number, or its icon.",
"enumNames": [
"Numbers",
"Icons"
]
},
"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 headline, the documents to bring, the steps, the place and opening times, the fees, the help line and the call to action."
},
"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=How%20to%20apply&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": "Citizen services",
"headline": "How to apply for your resident parking permit in Westbrook",
"subline": "Most permits are ready within five working days. Here is everything you need, step by step.",
"labels": {
"documents": "What you need",
"steps": "How to apply",
"visit": "Where and when",
"fees": "What it costs"
},
"documents": [
{
"icon": "user",
"name": "Proof of identity",
"detail": "Passport or national identity card"
},
{
"icon": "house",
"name": "Proof of address in the zone",
"detail": "Council tax bill or tenancy agreement"
},
{
"icon": "car",
"name": "Vehicle registration document",
"detail": "In your name and at the same address"
},
{
"icon": "mail",
"name": "An email address",
"detail": "Your digital permit is sent there"
}
],
"steps": [
{
"icon": "map-pin",
"title": "Check your parking zone",
"detail": "Enter your postcode on the zone map to see which permit area you live in."
},
{
"icon": "file-text",
"title": "Fill in the application",
"detail": "Apply online, or pick up a paper form at the Citizen Service Centre."
},
{
"icon": "clipboard-check",
"title": "Add your documents",
"detail": "Photos or scans are fine, as long as every page is complete and readable."
},
{
"icon": "car",
"title": "Pay and park",
"detail": "Pay by card. Your digital permit is linked to your number plate, no sticker."
}
],
"place": "Citizen Service Centre, Town Hall, Market Square 1",
"time": "Monday to Friday 8:00 to 16:00, Thursday until 18:00",
"picture": {
"alt": "Soft waves of blue, violet and orange",
"url": "media://example-image.jpg"
},
"currency": "EUR",
"fees": [
{
"label": "Permit for twelve months",
"amount": 60
},
{
"label": "Second vehicle in the household",
"amount": 90
},
{
"label": "Replacement or change of plate",
"amount": 12.5
}
],
"help": "Questions? Call 0123 456 789 or write to permits@westbrook.example",
"cta": {
"label": "Apply online",
"detail": "westbrook.example/parking"
},
"disclaimer": "Fees as of 1 October 2026. A permit is valid for twelve months from the day it is issued.",
"look": {
"theme": "brand",
"pace": "standard",
"corners": "soft",
"align": "start",
"stepLayout": "path",
"marker": "numbers",
"logo": "auto"
}
},
"metaData": {
"title": "How to apply for a resident parking permit",
"captionTiny": "Resident parking permit: what you need, four steps, the fees and where to get help.",
"captionShort": "Apply for your resident parking permit in four steps: check your zone, fill in the application, add your documents and pay. Most permits are ready within five working days. Apply online at westbrook.example/parking.",
"captionMedium": "How to apply for your resident parking permit in Westbrook. Have your proof of identity, proof of address in the zone, the vehicle registration document and an email address ready. Then check your parking zone, fill in the application online or at the Citizen Service Centre, add your documents and pay by card. A permit for twelve months costs 60 euros. Most permits are ready within five working days.",
"captionLong": "How to apply for your resident parking permit in Westbrook. Have your proof of identity, proof of address in the zone, the vehicle registration document and an email address ready. Then check your parking zone on the map, fill in the application online or pick up a paper form at the Citizen Service Centre, add your documents and pay by card. Your digital permit is linked to your number plate, so there is no sticker. A permit for twelve months costs 60 euros, a second vehicle 90 euros. The Citizen Service Centre at the Town Hall is open Monday to Friday from 8:00 to 16:00 and on Thursdays until 18:00. Questions? Call 0123 456 789.",
"hashtags": [
"westbrook",
"parkingpermit",
"citizenservices",
"howto"
]
}
}
}
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.