How do I add dynamic content from an API to my Overlays?

Utilizing our Live Elements feature in overlays allows you to enter a web APIs (RESTful API endpoints*), or any APIs that return JSON data, and return specific values within an overlay.  

With Dynamic Content overlays, you can dynamically update the elements of your interactive overlay with timely, relevant information straight from your (or any open) API. This removes the need to update frequently changing information or content at a manual level.

Ingesting dynamic content into your overlays allows you to integrate deeper and connect more fully with your existing systems that manage your data, product, information, etc. Plug-in any real-time, relevant data from a range of sources to your overlays, and save huge amounts of time from manually updating your data and content every time the data changes. 

For example, you may want to use a web API to dynamically update: 

  • Numerical data: Update a correct product price, event time, product units in stock, date, temperature, or other data
  • Images: Images that need to update frequently
  • Text: Surface the most recent blog post, event announcement, recent news, updates, new product description
  • URLs: URLs that will need to change frequently or always point the newest version

To add an endpoint to your video, choose 'Dynamic Content' from the upper left corner of the overlay editor. 

Depending on your API structure, the process of integrating your endpoint will look different per API. We've created extensive developer documentation on ingesting any API and creating paths to any element in your overlays. 

Currently, Dynamic Content in overlays is open to public APIs or APIs with API KEY / API TOKEN. Web APIs that need extra auth steps will require further development or third party services. Please feel free to talk to the WIREWAX team to verify the usability of an API.

For detailed instructions in ingesting and using a public API within overlay elements, please visit our Developer Hub

 

*Please note there are other types of APIs, such as GraphQL, which are not yet supported yet in Dynamic Content overlays.