First of all, it is important to know what a JSON file is and what it is for:
What is a JSON file?
JSON (JavaScript Object Notation) is an open standard file and data interchange format. It uses human-readable text to store and transmits data objects that consist of attribute-value pairs and arrays (or other serializable values).
It is a common data format with a diverse range of functionality in data interchange including communication of web applications with servers.
Source: json.org
Where is it possible to use JSON on Arena?
It is possible to include a JSON file in a stream, inside the Live Blog, or the Live Chat on Arena dashboard.
1 - Click on Stream
2 - Then, select the option Others
How do create you a Stream-compatible JSON and what properties should be included?
Creating a Stream-compatible JSON file is simple. Create a REST API with the following parameters below:
headline: the text displayed inside the dashboard
date: the publication date that is used to order the posts
time: the publication time that is used to order the posts
image: the image of your post. It can be news or any type of post you want to show on the Stream
link: the URL of the page where the content is
id: an ID for your control or a random one
title: the title of the publication that will be displayed on the dashboard
Example of a file with the properties above:
[
{
headline: "Premiership Rugby",
date: "2023-10-19",
time: "21:55:43.0862"
image:'https://d2cx26qpfwuhvu.cloudfront.net/gloucester/wp-content/uploads/2018/08/30131155/Gallagher_flag_Aug18_2000a-1024x584.jpg',
link:'https://www.gloucesterrugby.co.uk/2018/08/30/gallagher-kicks-off-premiership-rugby-season-with-celebration-of-gloucester-rugby-community-heroes/',
id: '22687',
title:'Gallagher kicks-off Premiership Rugby season with celebration of Gloucester Rugby community heroes',
}
]
Once the file is created, you will need to host it on your preferred server, insert the link in Stream and save it.
How is JSON displayed on the dashboard?
It will be displayed on the Stream tab like in the screenshot below.
How is JSON displayed in the public part?
It will be shown as a news card or a post.
Learn how other Stream integrations work:
Arena Team 🙂