Updates
- Last UpdatedJul 16, 2025
- 2 minute read
The Updates API allows users to retrieve the changed data for resources (for example, streams) in a specified Signup. This API is to be used after the signup Owner has successfully created a Signup using the Signups API. The signup Owner may begin a polling flow with this API by using the starter bookmark of an active Signup, provided through the Signups API (via GET /Signups/{signupId}).
Get Updates
Returns a sequence of change data updates for all resources within the Signup, starting from the sequential marker represented by a provided Bookmark.
Request
GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/signups/{signupId}/updates
?bookmark={bookmark}
Parameters
string tenantId
The tenant identifier.string namespaceId
The namespace identifier.string signupId
Signup unique identifier.string bookmark
An encoded token representing a sequential starting point from which users can retrieve updates for the current request. A starter Bookmark token appears in the response body of a successfully activated Signup.
Request Headers
| Header | Type | Required | Description |
|---|---|---|---|
| Community-Id | string | false | Community unique identifier. Must be provided to retrieve changed data for a signup containing resources shared through a community. |
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | string | Returns a sequence of updates. Absence of data for a successful response indicates that no new updates have arrived following the marker of the provided Bookmark, or that there is no data for the associated Signup. |
| 400 | None | Bad Request. The server could not understand the request due to malformed syntax. See response details for more information. |
| 401 | None | Unauthorized. The client is not authenticated. |
| 403 | None | Forbidden. The client is not authorized. |
| 500 | None | Internal Server Error. The server has encountered an error while processing the request. |
Example response body
200 Response
{
"data": [
{
"resourceId": "stream2",
"operation": "Insert",
"events": [
{
"Timestamp": "3/7/2024 12:00:00 AM",
"Value": 12
},
{
"Timestamp": "3/8/2024 12:00:00 AM",
"Value": 53
}
]
},
{
"resourceId": "stream1",
"operation": "Insert",
"events": [
{
"Timestamp": "3/7/2024 12:00:00 AM",
"Value": 234
},
{
"Timestamp": "3/8/2024 12:00:00 AM",
"Value": 7
}
]
},
{
"resourceId": "stream1",
"operation": "Remove",
"events": [
{
"Timestamp": "2024-03-07T00:00:00Z"
}
]
},
{
"resourceId": "stream2",
"operation": "Update",
"events": [
{
"Timestamp": "3/7/2024 12:00:00 AM",
"Value": 121
}
]
}
],
"bookmark": "H4sIAAAAAAAAChXEiQ2AMAwEwYKQ0dlxXtqggTxOFS6eoF1NyU_VZNusUw4LpCUqVVuDlHVP7dNkDheIEv5fkcalcb1DTJKLXEADnOGHEzz8foLRcKNaAAAA"
}