Important notice: changes to the Surfsight API

Upcoming changes to the Surfsight® API may impact the use of your service.

We will be changing the GPS data webhook "ID" field type from numeric to alphanumeric.

After the change, the GPS coordinate data “ID” parameter type will be expressed in alphanumeric format. If your service does not accept letters in the GPS data webhook "ID" field type, please make the necessary adjustments.

The patch update device webhooks will be changed to full patch behavior.

You will be able to update webhooks settings without deleting the current settings. When making a new API call from PATCH/organizations/{orgId}/webhook-settings, the call will no longer override the entire object in the configuration.

With this change, the new call will be combined with the existing object. The configuration will allow up to 3 URLs. If the combined configuration contains more than 3 unique URLs, it will return an error.

API GET device event enhancements

In order to prevent an excessive load on the database, we will be enforcing the start and end query string parameters on the GET /devices/{imei}/events endpoint to include up to 31 days of activity. This will result in a significant reduction in the number of 500 error codes.

If more than 31 days of activity are requested, you will receive a return status code 400 “bad request”.

API POST organization events enhancements

In order to prevent an excessive load on the database, we will be enforcing the start and end query string parameters on the POST /organizations/{orgId}/events endpoint to include up to 31 days of activity. This will result in a significant reduction in the number of 500 error codes.

POST /organizations/{orgId})/events will be set to Mandatory.

The begin and end query string parameters must be set to a maximum of a 31- day time period.

If more than 31 days of activity are requested, you will receive a return status code 400 “bad request”.

These changes will be implemented in the release scheduled for December 1, 2024.

We understand that these changes may cause some disruption to your workflow. We apologize for any inconvenience you might experience. If you have any questions or concerns, please reach out to your Technical Account Manager.

Thank you for your understanding and continued support.