Constructing a partner feed
Complete the following process to construct a partner feed.
- Create your feed files in either XML or JSON format.
- Populate the feed with relevant data (for example: closures, incidents,
or moving vehicles). Please note: You can provide closure and incident
information in the same feed.
We recommend that you use a schema checker to be sure that the file is correctly formatted and includes all the required parameters. Refer to XML validation for the file organization and road closure elements, incident elements, or moving vehicle elements for the specific details of the feed elements. Incorrectly formatted or incomplete files will not be processed for publication.
- Post the file where it can be accessed using a web browser. Refer to Feed file hosting for instructions on this requirement.
- If you’ve already joined our Partner Hub, log into your organization’s Portal account and add a link or upload the file to the relevant dataset. If you haven’t already signed on as a Waze For Cities partner, we ask that you fill out an application. Partnership is required for feed files to be accepted for posting.
- Once the file is posted, we will verify that the format and schema are correct. While we can make minor modifications, more significant flaws will result in the file being returned to you for correction. If your feed file is returned to you, you must fix the file, and then update your request in the Portal with a direct link to your revised feed file.
- After your feed is implemented in our systems, Waze automatically fetches the data and populates the map with the relevant incidents, closures, and other information. Data is fetched automatically every few minutes, and after the data is fetched, it may take an additional several minutes for the information to appear in the Waze app. If you have special requirement regarding the feed frequency please, contact the Waze team.
Sharing non-CIFS feed formats
ESRI (ArcGIS)
ArcGIS users can set up compatible feeds by sharing the RoadClosures_public layer within the Road Closures solution. Follow these instructions on the ESRI ArcGIS Solutions page to use the RoadClosures_public layer. Organize your data in the Closures layer and share it with Waze. Detours and Blocks layers are not supported.
Waze requires and consumes the data in the following way:
| Closures Layer Field | Waze Field(s) (CIFS Element) | Required | Data consumption and requirements |
|---|---|---|---|
globalID |
incident id | Required | Primary Unique Identifier. Provide a permanent, system-generated UUID that remains unchanged for the feature's entire lifecycle. |
reason + laneimpact |
type, subtype | Required | The reason and laneimpact are mapped to Waze CIFS Types/Subtypes.
Important: laneimpact shared with "All Lanes" or "Some Lanes" signifies a functional closure of lanes, rather than a simple road narrowing. "All Lanes" is interpreted as a full closure. The rest of the Coded Values are mapped to alerts. Examples:
|
geometry/paths |
polyline | Required | Provide Decimal Degrees (DD, projection SRID 4326) latitude and longitude coordinates that describe the location of the incident or road closure. These should ideally have at least 6 digits after the decimal point for sufficient accuracy.
The order of the coordinates must reflect the direction of the traffic that is affected. |
direction |
direction | Requested | Specifies whether the disruption or closure affects one or both traffic directions on the road. "One Direction" is mapped to ONE_DIRECTION; "Both Directions" is mapped to BOTH_DIRECTIONS. |
street |
street | Required | Specifies the name of the street or road on which the incident is occurring. An incident lacking a street cannot be injected into Waze. |
starttime |
starttime | Required | Specifies the start datetime for one period of disruption.
The timestamp can be provided in Epoch, or ISO8601 format in granularity of seconds and include the time zone offset. |
endtime |
endtime | Requested | Specify the end datetime using Epoch or ISO8601 format in granularity of seconds and include the timezone offset.
If you omit this, it will currently default to 14 days after start time. |
description |
description | Requested | The cause of the traffic disruption. This description should be less than 40 characters. A description that is more than 40 characters will be accepted, but may not display properly in the Waze app. |
activeincid |
N/A | Optional | Any incident with activeincid set to "No" is skipped and will not be injected into Waze. |
accessallowed |
N/A | Optional | Ignored. Waze events impact all drivers. |