Region map
Two to twenty-four regions compared on one value, each an equal hexagon placed roughly where it lies, so every region gets the same say: the empty map is the cover, then the colour sweeps across, levels on a ramp built from the brand or a change in its up and down colours, each value arriving with it, and the key under the map: 8 to 9 seconds. In eleven styles, each wearing your brand's colours, fonts, logo, presenter and background.
| Template id | tpl_69a179f0adbe |
|---|---|
| Markets | Every market |
| Variants | Election night, Weather map, Corporate glass, Bento grid, Broadcast news, Editorial, Swiss grid, Neo-brutalist, Clear civic, Soft friendly, Data terminal |
| Ready-made feeds | None |
Use cases
- One figure for each district, branch or region: air quality, prices, turnout, sales.
- Every region an equal hexagon placed roughly where it lies, so small places count as much as large ones.
- The colour on a scale from your brand, or the change up and down, with its key under the map.
Variants
A variant is this template drawn another way, and it comes in versions: immutable builds, the newest first. A channel follows the newest version of its variant, unless it is pinned to one.
| Variant | What it is | Versions | Newest |
|---|---|---|---|
| Election night | A results studio in your colours: panels sliding in on deep bands, figures climbing and the result stamped on. | 1 | 1.0.0 |
| Weather map | A forecaster's board in your colours: isobars and a front sweeping behind, rounded cards and badges popping up. | 1 | 1.0.0 |
| Corporate glass | Frosted glass cards over an aurora in your brand colours: calm and premium. | 1 | 1.0.0 |
| Bento grid | Rounded tiles in your brand colours, each moving on its own: a modern product look. | 1 | 1.0.0 |
| Broadcast news | A news channel in your colours: channel bug, lower third, ticker and your presenter. | 1 | 1.0.0 |
| Editorial | A magazine page in your paper tone and serif: masthead, hairline rules and a byline. | 1 | 1.0.0 |
| Swiss grid | A strict grid, large type and your brand colour as the one accent. Nothing bounces. | 1 | 1.0.0 |
| Neo-brutalist | Loud flat blocks in your colours with thick borders and hard shadows. | 1 | 1.0.0 |
| Clear civic | Built for reading: high contrast, large plain type and numbered steps. | 1 | 1.0.0 |
| Soft friendly | Soft shapes and rounded cards in tints of your brand colour: warm and approachable. | 1 | 1.0.0 |
| Data terminal | A market terminal whose ink is your brand colour, the figures scrambling into place. | 1 | 1.0.0 |
What it accepts
Every variant takes the same content, so one document draws in any of them.
Region map: regions compared on one value, each an equal hexagon placed roughly where it lies, coloured on a scale built from the brand, levels or a change, with its key, sweeping across. 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: a kicker, the title, the regions with their values and places, the scale and what it shows, a note, the source and the look. | |
clipData.kicker | text | up to 20 characters | Kicker: A word above the title, such as AIR QUALITY or TODAY. | |
clipData.title | text | yes | up to 80 characters | Title: Shown from the first frame with every hexagon, still empty. |
clipData.prefix | text | up to 3 characters | Prefix: Written before every value, such as a currency sign. | |
clipData.unit | text | up to 8 characters | Unit: Written after every value: %, mm, EUR. | |
clipData.scale | enum | levels, change | Colours: Levels: two to six classes on a ramp from your brand colour, quiet for the lowest and deep for the highest, for values where more means more. Change: your brand's up colour above nought and its down colour below, every value with its sign. | |
clipData.scaleLabel | text | up to 30 characters | What the colour shows: Written beside the colour key. | |
clipData.regions | list | yes | at least 2, up to 24 | Regions: Two to twenty-four. Placed by column and row where both are sent, every odd row half a hexagon to the right, so neighbours on the map can be neighbours here; packed in the order sent where they are not. |
clipData.regions[] | group | Region | ||
clipData.regions[].name | text | yes | up to 22 characters | Name |
clipData.regions[].short | text | up to 4 characters | Short name: Written in the hexagon where the name does not fit. | |
clipData.regions[].value | number | yes | 4 decimals | Value |
clipData.regions[].col | integer | from 0, to 12 | Column: From 0 at the left. | |
clipData.regions[].row | integer | from 0, to 12 | Row: From 0 at the top. | |
clipData.note | text | up to 100 characters | Note: One line under the map. | |
clipData.source | text | up to 70 characters | Source: A line at the foot. Drawn exactly as written. | |
clipData.styleWords | group | Style words: The few words some styles write into their own frame, each drawn exactly as written, in the language you write it in. A word left out is not drawn: no template adds a word of its own. The same keys in every format of the collections; each style draws only its own. | ||
clipData.styleWords.live | text | up to 16 characters | Live marker (Broadcast news): Written beside the light in Broadcast news' channel bug, such as LIVE. Left out, the light stands alone. | |
clipData.styleWords.byline | text | up to 12 characters | Byline (Editorial): Written before the presenter's name in Editorial, such as By. Left out, the name stands alone. | |
clipData.styleWords.functionKeys | list | up to 4 | Function keys (Data terminal): Data terminal's row of keys F1 to F4, one word each, in order, such as HELP, DATA, CHART and NEWS; the second is drawn held down, and a key that does not fit the row is left out. Left out, no keys are drawn. | |
clipData.styleWords.functionKeys[] | text | up to 12 characters | Key | |
clipData.styleWords.commandKey | text | up to 10 characters | Command key (Data terminal): The key at the end of Data terminal's row, in the rise colour, such as GO. Left out, none is drawn. | |
clipData.styleWords.realTime | text | up to 12 characters | Real-time light (Data terminal): Written beside the blinking light in Data terminal's status bar, such as RT. Left out, the light stands alone. | |
clipData.styleWords.messageLabel | text | up to 12 characters | Message window label (Data terminal): The tab on Data terminal's message window round the presenter, such as MSG. Left out, the window has no tab. | |
clipData.styleWords.pictureLabel | text | up to 12 characters | Picture panel label (Data terminal): Written in the strip along the top of Data terminal's picture panels, such as IMG. Left out, the strip stays empty. | |
clipData.look | group | Look: How the clip looks and moves within its style. The same switches in every format of the collections. Leave a switch out, or set it to the style's own, and the style decides. | ||
clipData.look.theme | enum | auto, brand, light, dark, bold | Theme: The style's own choice; your brand's own colours and background; a light or dark page tinted with your brand colour; or your brand colour as the page. | |
clipData.look.pace | enum | auto, calm, standard, punchy | Pace: How things arrive: the style's own rhythm, calm fades, a standard rhythm, or punchy slams and cuts. | |
clipData.look.corners | enum | auto, square, soft, round | Corners: The shape of cards, panels and marks. | |
clipData.look.align | enum | auto, start, centre | Text alignment: Where the text lines up. | |
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. | |
clipData.look.logoSize | enum | auto, small, large | Logo size: Standard is the style's own size. Small draws the logo a fifth smaller, with its plate. Large draws it a quarter larger wherever the style has room for it, and at the standard size where it has none. | |
clipData.look.hideHeader | boolean | Hide logo and title: Leaves out the line at the top of the clip: your logo, the title line and the style's decoration around them, so the content starts at the top. To leave it out of every clip, switch Logo and title line off in your brand's settings. | ||
clipData.look.hideFooter | boolean | Hide footer line: Leaves out your footer line at the foot of the clip, with whatever the style draws only to carry it, so the content reaches further down. Your presenter and the source line stay. To leave it out of every clip, switch Footer line off in your brand's settings. | ||
clipData.look.pattern | enum | auto, none, dots, grid, lines | Background pattern: The fine texture behind the content. The style's own keeps what the style draws there, and some styles draw none. None leaves the background plain. Dots, Grid and Diagonal lines draw that pattern faintly instead, the same in every style, in the colour of your page. | |
metaData | group | Meta data: Everything about the post that is never drawn in the clip: its title, its description in four lengths, one per kind of platform, and its hashtags. Reelwire adds the brand's description, link and hashtags after it. Left out, the post text is generated from the clip data. | ||
metaData.title | text | up to 100 characters | Title: Used where the platform has a title of its own: Facebook Feed, LinkedIn, Pinterest and YouTube. Up to 100 characters, which every one of them takes. | |
metaData.captionTiny | text | up to 200 characters | Tiny description (Pinterest, Threads, X): Up to 200 characters. The brand's description, link and hashtags follow it within the platform's limit. | |
metaData.captionShort | text | up to 500 characters | Short description (Telegram, Threema, WeChat, WhatsApp): Up to 500 characters. The brand's description, link and hashtags follow it within the platform's limit. | |
metaData.captionMedium | text | up to 1500 characters | Medium description (Discord, Facebook Reels, Instagram, LinkedIn, Signal, Slack, TikTok): Up to 1500 characters. The brand's description, link and hashtags follow it within the platform's limit. | |
metaData.captionLong | text | up to 4000 characters | Long description (Facebook Feed, YouTube): Up to 4000 characters. The brand's description, link and hashtags follow it within the platform's limit. | |
metaData.hashtags | list | up to 15 | Hashtags: Written without the #. Up to 15, which every platform takes. | |
metaData.hashtags[] | text | up to 60 characters | Hashtag |
locales carries other languages: under each language code, the parts of clipData and metaData that differ, laid over the default, so a language with no copy still renders.
A picture is always a file from your media library: media:// followed by its id or its name.
Anything the table does not list is refused, and so is anything over its limit, with a 400
schema_validation error that names the field.
Ask Reelwire for the whole JSON Schema, the document your content is checked against, without signing in:
curl "https://app.reelwire.io/v1/formats/template/tpl_69a179f0adbe?variant=Election%20night&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": "Air quality",
"title": "The air was worst by the docks and the harbour this morning, best on the hills",
"prefix": "",
"unit": "",
"scale": "levels",
"scaleLabel": "Air quality index",
"regions": [
{
"col": 1,
"row": 0,
"name": "Northgate",
"short": "NGT",
"value": 28
},
{
"col": 2,
"row": 0,
"name": "Hillcrest",
"short": "HIL",
"value": 22
},
{
"col": 3,
"row": 0,
"name": "Fairview",
"short": "FAI",
"value": 35
},
{
"col": 0,
"row": 1,
"name": "Westmoor",
"short": "WMR",
"value": 41
},
{
"col": 1,
"row": 1,
"name": "Old Town",
"short": "OLD",
"value": 88
},
{
"col": 2,
"row": 1,
"name": "Market Hall",
"short": "MKT",
"value": 104
},
{
"col": 3,
"row": 1,
"name": "Eastfield",
"short": "EST",
"value": 52
},
{
"col": 0,
"row": 2,
"name": "Riverside",
"short": "RIV",
"value": 63
},
{
"col": 1,
"row": 2,
"name": "Cathedral Quarter",
"short": "CAT",
"value": 97
},
{
"col": 2,
"row": 2,
"name": "Docklands",
"short": "DCK",
"value": 142
},
{
"col": 3,
"row": 2,
"name": "Mill Lane",
"short": "MIL",
"value": 76
},
{
"col": 4,
"row": 2,
"name": "Seaview",
"short": "SEA",
"value": 31
},
{
"col": 1,
"row": 3,
"name": "Southbank",
"short": "SBK",
"value": 58
},
{
"col": 2,
"row": 3,
"name": "Harbour",
"short": "HBR",
"value": 121
},
{
"col": 3,
"row": 3,
"name": "Lighthouse",
"short": "LGT",
"value": 45
},
{
"col": 2,
"row": 4,
"name": "Gull Point",
"short": "GPT",
"value": 18
}
],
"note": "Above 100 the city advises people with asthma to avoid hard exercise outdoors",
"source": "Westbrook air monitoring network, 08:00",
"styleWords": {
"live": "LIVE",
"byline": "By",
"functionKeys": [
"HELP",
"DATA",
"CHART",
"NEWS"
],
"commandKey": "GO",
"realTime": "RT",
"messageLabel": "MSG",
"pictureLabel": "IMG"
},
"look": {
"theme": "auto",
"pace": "auto",
"corners": "auto",
"align": "auto",
"logo": "auto",
"logoSize": "auto",
"hideHeader": false,
"hideFooter": false,
"pattern": "auto"
}
},
"metaData": {
"title": "Where the air was worst this morning",
"captionTiny": "Air quality this morning: worst by the Docklands (142) and the Harbour (121), best at Gull Point (18) and on the hills.",
"captionShort": "This morning's air quality across Westbrook: worst by the Docklands at 142 and the Harbour at 121, best at Gull Point at 18 and in Hillcrest at 22. Above 100 the city advises people with asthma to avoid hard exercise outdoors.",
"captionMedium": "Air quality across Westbrook this morning, by district.\n\nWorst: Docklands 142, Harbour 121, Market Hall 104.\nBest: Gull Point 18, Hillcrest 22, Northgate 28.\n\nAbove 100 the city advises people with asthma to avoid hard exercise outdoors. Readings from the city's monitoring network at 08:00.",
"captionLong": "Here is how the air looked across Westbrook at 8 this morning, district by district, from the city's monitoring network.\n\nThe air was worst around the port: the Docklands read 142, the Harbour 121 and Market Hall 104, where the morning traffic meets the ships. On the hills it was clean: Gull Point read 18, Hillcrest 22 and Northgate 28.\n\nAbove 100 the city advises people with asthma or heart conditions to avoid hard exercise outdoors. Readings usually ease by midday as the wind picks up.",
"hashtags": [
"airquality",
"westbrook",
"health",
"city",
"map"
]
}
}
}
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.