Feed Setup

The following information will help you get your feeds set up and running correctly.

Feed file hosting

The Waze content acquisition system automatically fetches all new or modified files in a particular directory or set of directories. To ensure that Waze retrieves the correct feed files, follow these guidelines when making your feeds available on your HTTP server:

  • Create your feed in a directory from which Waze does not fetch content.
  • When your feed is complete, create a symbolic link in a directory from which Waze does fetch content; the symbolic link should point to the newly created feed. Typically this is done using a $ ln -s source_file my_file command. You can secure your files with a username and password using either BASIC or DIGEST authentication. Windows NT LAN Manager (NTLM) is not currently supported.
  • We transfer the feed files using HTTPS with a SSL certificate to secure the data transfer.
  • You provide the login and password combination through the CCP portal.
  • The content acquisition system fetches data every 5 minutes. If your feed is updated significantly more frequently or less frequently than every 5 minutes, contact the Waze team so that we can adjust our polling periods to reflect your feed update cycle.

XML validation

Waze uses the following XML schema to define the acceptable structure of a Closure and Incidents Feed Specifications (CIFS) feed: https://www.gstatic.com/road-incidents/incidents_feed.xsd.

There are a number of tools available on the internet that can help you validate the structure of your XML feeds. These include, but are not limited to:

Critical feed changes

Before making any of the following changes, notify the Waze team by completing this form and editing your request in the Portal to identify the updated feed.

  • Modifying, adding, or removing regions or countries from your feed.
  • Updating the feed URL or any credentials required for accessing the information.

Feed specifications

A single feed file can provide information on multiple closures and incidents. If you are providing information on multple events, each closure or incident must be detailed in a separate section similar to the road closure example, and each closure instance must have a unique ID. These sections should use the local time and date. The parameter tables for each feed type classify each element as follows:

  • Required: This element must be present and populated for your feed to be considered valid.
  • Optional: This element is not required to be present and populated for your feed to be considered valid.