Workstars TV

With Workstars TV, you can display the most recent wall entries on any screen in your office. It’s an easy way to publicly promote your recognitions and share activity with your employees.

How do I set it up?

Please follow the setup wizard in the administration portal to generate a URL. Once you have generated a URL:

  • If your screen includes a built in browser, you simple paste in the URL and wait for it to load.
  • If your screen doesnt have a built in browser, you need to connect a PC to your screen and paste the URL into the browser on the PC.

Can I get the data to use in other systems?

Yes, you have two choices:

1. JSON Data

You can request the raw data (in JSON format) which your technical team can use in your own system (intranet, sharepoint, etc.). They can request the data as JSON (see below section) and then write some code (client side e.g. Javascript or server side e.g. PHP) to display the data in the layout you require.

2. Embed in a page

You can simply embed the Workstars TV in the page using an <iframe>.

How to request the data as JSON

Latest (Version 3)

To request a JSON response instead of the HTML page, you simply need to add a couple of parameters (“response=json” & “version=3”) onto the end of your URL. You do this by adding a “?” on the end of the URL and a “&” between the 2 values, below is an example URL:

https://subdomain.workstars.com/tv/47io11c5l9m6ykjzpeh959jlb31npy3s?response=json&version=3

which would generate the following response:

HTTP/1.1 200 OK
{
    "wall": [
        {
            "type": "adhoc_award",
            "initiator": {
                "first_name": "Anne",
                "last_name": "Lewis",
                "image": "https://d32rcf07aj0hbp.cloudfront.net/pDwQ5K49dIo8GfhOEsgnxt6jNvAm23yiWR7Pa.jpeg"
            },
            "recipients": [
                {
                    "first_name": "Richard",
                    "last_name": "Jones",
                    "image": "https://d32rcf07aj0hbp.cloudfront.net/3yiWR7PaK49dIpDwQfhOEsgnxt6jNvAm52o8G.jpeg"
                }
            ],
            "title": "Sales Person of the Month",
            "reason": "Well done on your sales figures last week, it made all the difference to the company!",
            "created_at": "2014-10-20T11:55:29Z"
        },
        {
            "type": "recognition",
            "initiator": {
                "first_name": "Anne",
                "last_name": "Lewis",
                "image": "https://d32rcf07aj0hbp.cloudfront.net/pDwQ5K49dIo8GfhOEsgnxt6jNvAm23yiWR7Pa.jpeg"
            },
            "recipients": [
                {
                    "first_name": "Alex",
                    "last_name": "Murphy",
                    "image": "https://d32rcf07aj0hbp.cloudfront.net/pDwQ5K49dIo8GfhOEsgnxt6jNvAm23yiWR7Pa.jpeg"
                },
                {
                    "first_name": "Chris",
                    "last_name": "Jones",
                    "image": "https://d32rcf07aj0hbp.cloudfront.net/pDwQ5K49dIo8GfhOEsgnxt6jNvAm23yiWR7Pb.jpeg"
                }
            ],
            "title": "We Play to Win",
            "reason": "Well done everyone for managing the network last night",
            "created_at": "2014-09-30T15:25:22Z"
        },
        {
            "type": "service_award_onboarding",
            "initiator": {
                "first_name": "Anne",
                "last_name": "Lewis",
                "image": "https://d32rcf07aj0hbp.cloudfront.net/pDwQ5K49dIo8GfhOEsgnxt6jNvAm23yiWR7Pa.jpeg"
            },
            "recipients": [
                {
                    "first_name": "Burt",
                    "last_name": "Halsey",
                    "image": "https://d32rcf07aj0hbp.cloudfront.net/gnxt6jpDwQ523yiWRdIo8GfhOEsNvAm7PaK49.jpeg"
                }
            ],
            "title": "1 Week",
            "reason": "Can you believe it has been 1 weeks since you started?",
            "created_at": "2014-09-30T15:25:22Z"
        },
        {
            "type": "service_award_long",
            "initiator": {
                "first_name": "Anne",
                "last_name": "Lewis",
                "image": "https://d32rcf07aj0hbp.cloudfront.net/pDwQ5K49dIo8GfhOEsgnxt6jNvAm23yiWR7Pa.jpeg"
            },
            "recipients": [
                {
                    "first_name": "Burt",
                    "last_name": "Halsey",
                    "image": "https://d32rcf07aj0hbp.cloudfront.net/gnxt6jpDwQ523yiWRdIo8GfhOEsNvAm7PaK49.jpeg"
                }
            ],
            "title": "2 Years",
            "reason": "Can you believe it has been 1 weeks since you started?",
            "created_at": "2014-09-30T15:25:22Z"
        },
        {
            "type": "company_award_nomination",
            "initiator": {
                "first_name": "Anne",
                "last_name": "Lewis",
                "image": "https://d32rcf07aj0hbp.cloudfront.net/pDwQ5K49dIo8GfhOEsgnxt6jNvAm23yiWR7Pa.jpeg"
            },
            "recipients": [
                {
                    "first_name": "Burt",
                    "last_name": "Halsey",
                    "image": "https://d32rcf07aj0hbp.cloudfront.net/gnxt6jpDwQ523yiWRdIo8GfhOEsNvAm7PaK49.jpeg"
                }
            ],
            "title": "Employee of the Year",
            "reason": "Bert's customer service ratings have been outstanding, 5/5 stars on every ticket he's completed",
            "created_at": "2014-09-30T15:25:22Z"
        },
        {
            "type": "company_award_winners",
            "initiator": {
                "first_name": "Anne",
                "last_name": "Lewis",
                "image": "https://d32rcf07aj0hbp.cloudfront.net/pDwQ5K49dIo8GfhOEsgnxt6jNvAm23yiWR7Pa.jpeg"
            },
            "recipients": [
                {
                    "first_name": "Burt",
                    "last_name": "Halsey",
                    "image": "https://d32rcf07aj0hbp.cloudfront.net/pDwQ5K49dIo8GfhOEsgnxt6jNvAm23yiWR7Pa.jpeg"
                },
                {
                    "first_name": "Chris",
                    "last_name": "Jones",
                    "image": "https://d32rcf07aj0hbp.cloudfront.net/pDwQ5K49dIo8GfhOEsgnxt6jNvAm23yiWR7Pb.jpeg"
                },
                {
                    "first_name": "Anne",
                    "last_name": "Lewis",
                    "image": "https://d32rcf07aj0hbp.cloudfront.net/pDwQ5K49dIo8GfhOEsgnxt6jNvAm23yiWR7Pc.jpeg"
                }
            ],
            "title": "Employee of the Year",
            "reason": "Well done everyone on their performance this year, it has been exceptional!",
            "created_at": "2014-10-11T15:25:22Z"
        }
    ]
}

The following types are returned:

Type Number Recipients Description
adhoc_award 1 When an administrator makes an adhoc financial reward
recognition 1 or many When a recocognition is given
service_award_onboarding 1 or many When an onboarding service award is processed
service_award_long 1 or many When a long service award is processed
company_award_nomination 1 When an employee nominates someone for a company award
company_award_winners 1 or many When the company award winners have been announced

FAQ’s

Why cant I see new posts immediately?

This is because we cache the response for 5 minutes to help with performance.

Why am I being blocked?

If you access a URL with the wrong token (the random part after /tv/) too many times, you will be blocked for 10 minutes. This is for security reasons and is usually because you are using an old URL or you have copied it incorrectly.

Why am I being throttled?

If you access URL more than 60 times in a minute you will be temporarily blocked.

  • This is once every second, which is enough to have it embedded in a web page (intranet, sharepoint, etc.). If you have alot of traffic to your site you might hit this limit, in this case you should update your code to cache the response in the users browser for 5 minutes.
  • If you are using the URL in a script, we suggest you only access it once every 5 minutes as the responses are cached anyway.