Synchronization

Synchronize the calculated score from the Data Cloud for a given score category. The fetched scores are stored in the HealthScore object.

The sync API first validates that the score category is mapped to a valid Data Cloud Calculated Insight. If this step is successful, the request is then passed to the Messaging queue where the scores are fetched from Data Cloud. After the messaging queue fetches the scores, they are then submitted to a bulk job that inserts the new scores in HealthScore.

Resource 

1/connect/health/scores/synchronization

Resource Example 

Replace {yourInstance} with the My Domain name of your Salesforce org, and replace {XX.X} with the API version.

1https://{yourInstance}.salesforce.com/services/data/v{XX.X}/connect​/health/scores/synchronization

Available Version 

55.0

Requires Chatter 

No

HTTP Methods 

POST

Root XML tag 

<HpiScoreSyncInput>

JSON example 

1{
2   "categoryName" : "HPI"
3}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
categoryNameStringThe name of the score category for which the score synchronization is triggered.Required55.0
debugModeBooleanFor internal use only.Optional55.0
timestampStringFor internal use only.Optional55.0

Response Body for POST 

HPI Score Sync Output