Deprecation Notices

Upcoming Breaking Changes - May, 2021

On September 1st, 2022, Timeline API GET requests will no longer support the following query parameter formats:

  • fields[]=value1&fields[]=value2

The only supported and recommended to use format for GET requests is comma-separated values like fields=value1,value2,...,

Event's "Location" in Webhook Payload - Effective July 1st, 2021

What’s changing?
The webhook payload for alerts is going under the change to only support locations object (plural, each child consisting of an id), versus the outdated location attribute.

{
    "data": {
        "alert": ...alert,
        "insight": ...insight,
        "locations": [ // introduced
          { "id": "38f689d83c264eb0b084ba39975f3413" }, 
        ],
        "location": ...location, // deprecated
        "notification": ...notification,
        "event": ...event
    }
}

Why are you making this change?
As part of our release of alerts based on insight categories (reporting severe weather events issued by national authorities), we have extended the notification payload sent to your webhook to support multiple locations. This is needed to de-dup notifications for a singular weather event, thereby reducing alert fatigue in developer's applications.

When is this going to happen?
Effective immediately, all payloads will consist of both location and locations objects throughout the deprecation period. On July 1st, the deprecation date, the location object will be redacted.

What will happen if I do nothing?
Until the above-mentioned date, apps developed on top of our alerting system will continue to work without change. Afterward, ones relying on that object, to avoid any business disruption on your end make sure to migrate your code to use the new object structure.

Note that this is true to any alert notification type, regardless if they are triggered by a custom insight (with tailored conditions) or by any of the events residing under an insight category.

What are the alternatives?
As said, the only alternative to the previous functionality of the location object is to use the first object of the locations array.

For any issues or questions, please contact our support at [email protected].