For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DocsAPI ReferenceChangelog
DocsAPI ReferenceChangelog
  • REST
    • Authentication
    • Platform
    • Event-Driven Sync (EDRTS)
    • Content
    • FeedAMP Order
    • FeedAMP Order V2
    • FeedAMP Order Source
LogoLogo
On this page
  • Terminology
  • Correlation ID
  • Rate Limiting
REST

Event-Driven Sync API (EDRTS)

Was this page helpful?
Previous

Deletes the vault entry

Next

Insert / Update Records

Built with

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.

1{"status":"fail","message":"Rate Limit Exceeded. Please wait -timeUntilReset- seconds before trying again."}