Data Change Polling
The API provides time stamps created_at and modified_at that can be used to query for changes after a specified time. Using these fields a simple API call can be used to check if any data has been modified since the last check (polling).
Avoid polling the API simply to check for changes at a high rate. An acceptable frequency would be in the range of once an hour. If you need higher frequency a notification web-hook is more appropriate.
Data Change Notifications (Web-hooks)
The API provides a set of REST endpoints to manage notifications or web-hooks. A URL can be specified that will be called when the related data (organization, athlete, session) is updated.
Failure and Retry
If a call to a web-hook URL returns anything other than HTTP 200. Then a retry will be queued with a delay of 30 seconds. Retry will occur a maximum of 3 times. Additional delay time is increased with each attempt.
Web-hook Payload Format
The specified URL will be called with a HTTP POST request. The payload contains information about the data entities that have changed included their type, identifier.
Example
{
"data": [
{
"organization_id": "1",
"athlete_id": "101",
"session_id": "232",
"entity_type": "session",
"change_type": "modify",
"time": "2026-08-08T01:02:40.1606648+00:00"
}
]
}
Field | Example | Description |
|---|---|---|
organization_id | 1 | Organization identifier |
athlete_id | 101 | Valid if entity_type is ‘athlete’ or ‘session’ |
session_id | 232 | Valid if entity_type is ‘session’ |
entity_type | session | organization, athlete, session |
change_type | modify | create, modify, delete |
time | 2026-08-08T01:02:40.1606648+00:00 | The timestamp of the change |