Manage change broker community data updates
- Last UpdatedJun 10, 2025
- 4 minute read
You can use the API console to configure a Signup that collects data updates from a community. For more on communities, read Communities.
Follow the steps below to create a Signup, activate a Signup, and receive change data updates. Note that all steps must be done in order.
For developer API documentation, read the change broker API reference guide.
Preparations
Before you create a Signup for your community, you must copy the community Id and stream URL.
-
In the left pane, select Data Management > Communities.
-
Select the community for which you want to create a Signup.
-
Select Community Details in the side sheet.
-
Copy the Community Id.
Paste the community Id in an accessible place. You will need this later.
-
Select the tenant that contains the stream you want to create a Signup for.
-
Select the Streams tab in the tenant details pane.
-
Select
View Streams.
-
Select the Namespace/Communities drop-down and then select the community you previously copied the community Id from.
-
Select the checkbox for the tenant you want to filter by.
-
Select the stream you want for the Signup.
-
Copy the Stream URL from the stream details pane.
Paste the stream URL in an accessible place. You will need this later.
Create a Signup for a community
To sign up for change data updates from streams of interest, perform the following steps:
-
In the left pane, select Developer Tools > API Console.
-
Select v1 in the targeted API version dropdown selector.
-
Select the
home icon to clear the path and tenant values.
The Community-Id field appears.
-
Select POST in the Verb dropdown selector.
The POST button appears.
-
Use the Stream URL copied from before to fill out the URI field.
For example, the URI should be written as /tenants/[tenant Id]/namespaces/[namespace Id]/Signups.
-
Select the checkbox for Community-Id and paste the community Id in the Community-Id field.
-
Paste the body text in the Body field. You should include the name of your Signup in the Name field, the resource type in the ResourceType field (currently, Stream is the only ResourceType supported by change broker), and the stream Id in the ResourceIds field. See below for an example:
{
"Name": "<community stream name>",
"ResourceType": 0,
"ResourceIds": [
"<stream name>"
]
}
-
Select the POST button.
You should receive output containing a Signup Id and a SignupState of Activating.
{
"Id": "<GUID>",
"Name": "<resource name>",
"Owner": {
"Type": "User",
"ObjectId": "<GUID>",
"TenantId": "<GUID>"
},
"CommunityId": "",
"Type": "Stream",
"CreatedDate": "2019-08-24T14:15:22Z",
"ModifiedDate": "2019-08-24T14:15:22Z",
"SignupState": "Activating"
}
Activate a Signup for a community
To activate a Signup for a community to begin to queue change data updates, perform the following steps:
-
Copy the Id provided in the previous output.
-
Select GET in the Verb dropdown selector.
The GET button appears.
-
In the URI field, type / at the end of the existing text, then paste in your Id.
-
Confirm the Community-Id header is still present. If it is not, select the checkbox for Community-Id and paste the community Id in the Community-Id field.
-
Select the GET button.
Note: Very large Signups may take time to complete creation and may return a SignupState of "Activating" instead of the SignupState of "Active."
A SignupState of Active appears in the output. This indicates that change data is being collected for the streams in the Signup. A bookmark also appears in the output.
{
"bookmark": "<GUID>",
"Id": "<GUID>",
"Name": "<resource name>",
"Owner": {
"Type": 1,
"ObjectId": "<GUID>",
"TenantId": "<GUID>"
},
"CommunityId": "<GUID>",
"Type": "Stream",
"CreatedDate": "2019-08-24T14:15:22Z",
"ModifiedDate": "2019-08-24T14:15:22Z",
"SignupState": "Active"
}
You can now use the active community signup to query for updates from the shared stream using the /signups/{{signupId}}/updates?bookmark={{bookmark}} endpoint.
Receive community change data updates
To receive community stream updates, perform the following steps:
-
Select GET in the Verb dropdown selector.
The GET button appears.
-
In the URI field, type / at the end of the existing text, then paste in your /signups/{{signupId}}/updates?bookmark={{bookmark}} endpoint.
-
Confirm the Community-Id header is still present. If it is not, select the checkbox for Community-Id and paste the community Id in the Community-Id field.
-
Select the GET button.
The stream updates appear in the output.
{
"data": [
{
"resourceId": "<resource Id>",
"operation": "Update",
"events": [
{
"Timestamp": "<timestamp>",
"Value": <GUID>
}
]
}
],
"bookmark": "<GUID>"
}
You will now receive community data event updates via the Change Data Broker. You must use the provided bookmark in this output in the next /Updates call to receive the next set of change data.