Event-Driven Sync API (EDRTS)
Event-Driven Sync API (EDRTS)
The Event-Driven Sync API allows you to update data across channels in near real-time by inserting or updating records, triggering exports as needed. Rate-limiting policies are in place to maintain system stability and should be followed when making API calls.
Use this API to:
- Insert and update data records in real time
- Retrieve and review data for validation
- Manage rate limits effectively
Terminology
Correlation ID
Each PUT request for data operations is assigned a unique identifier; correlation id. This identifier can be used in subsequent API requests to obtain detailed information about the associated job.
Rate Limiting
Included headers in every authenticated response (success or failure):
- X-Rate-Limit-Group: The name of the API group.
- X-Rate-Limit-Remaining: The number of remaining requests in the current time window.
- X-Rate-Limit-Reset: The timestamp when the rate limit will reset.
If the rate limit is exceeded, the API will return an HTTP 429 status code and a message with how long to wait until the limit resets.
