Loading
Get Started with B2C Commerce
Process-Level Replication Events

You are here:

  1. Salesforce Help
  2. Docs
  3. B2C Commerce for Merchandisers and Administrators

Process-Level Replication Events

Process-level replication events fire when a B2C Commerce replication process reaches a terminal state. Use them to track when bulk replication jobs complete or fail.

Available in: B2C Commerce release 26.6 and later.

Event IDs

Event ID Description When fired
sf.cc.replication.completed Replication completed successfully When a replication process reaches COMPLETED state
sf.cc.replication.failed Replication failed When a replication process reaches FAILED state

HTTP headers

Process-level replication events use the standard headers documented in Common HTTP Headers for B2C Commerce Events, with x-sf-cc-event-id set to the event ID listed above.

Common payload fields

Both sf.cc.replication.completed and sf.cc.replication.failed events include these fields inside the payload object.

Field Type Required Description
processId string Yes Unique identifier for the replication process
uuid string Yes UUID of the replication process
type string Yes Type of replication process (see Process types)
targetSystem string Yes Target system name, typically Development or Production
state string Yes Current state of the process (see Process states)
isDataReplication boolean Yes true for data replication, false for code replication
success boolean Yes true for completed events, false for failed events
description string No User-provided description of the replication process
codeVersion string No Code version identifier for code replications
replicationGroups array Yes List of replication groups included. See Replication Group IDs.
startDate string Yes ISO-8601 timestamp when process started
endDate string Yes ISO-8601 timestamp when process ended

Failed events (sf.cc.replication.failed) also include errorState, a machine-readable error code. See Replication Error States.

Process types

The type field indicates the replication operation.

Data replication value Description
ReplicationPublication Data transfer and immediate publishing
Replication Data transfer only (two-stage replication)
Publication Publishing previously transferred data
Undo Undo a previous replication
Code replication value Description
CodeReplicationPublication Code transfer and immediate publishing
CodeReplication Code transfer only
CodePublication Publishing previously transferred code
CodeUndo Undo a previous code replication

Process states

The state field indicates the process state.

Value Description
WAITING Process is created and ready to start
INITIALIZING Process is preparing to run
RUNNING Process is in progress
FINALIZING Process is finalizing
COMPLETED Process completed successfully
FAILED Process failed
Note
Note CANCELED is deprecated and shouldn't appear in new events.

Example: successful data replication


{
"eventType": "sf.cc.replication.completed",
"timestamp": "2026-03-11T13:31:13.755934395Z",
"tenantId": "zzzz_stg",
"payload": {
"processId": "12345",
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"type": "ReplicationPublication",
"targetSystem": "Production",
"state": "COMPLETED",
"isDataReplication": true,
"success": true,
"description": "Weekly catalog update",
"replicationGroups": [
{
"id": "ORGANIZATION_CATALOG",
"type": "ORGANIZATION"
},
{
"id": "CATALOG",
"type": "REPOSITORY",
"domain": "storefront-catalog-m-en"
}
],
"startDate": "2026-03-11T13:31:03Z",
"endDate": "2026-03-11T13:31:13.727Z"
}
}

Example: failed replication


{
"eventType": "sf.cc.replication.failed",
"timestamp": "2026-03-11T14:22:18.442Z",
"tenantId": "zzzz_prd",
"payload": {
"processId": "12346",
"uuid": "660e8400-e29b-41d4-a716-446655440001",
"type": "Replication",
"targetSystem": "Production",
"state": "FAILED",
"isDataReplication": true,
"success": false,
"description": "Emergency content update",
"errorState": "ErrorConnectLiveSystem",
"replicationGroups": [
{
"id": "SITE_CONTENT",
"type": "SITE"
},
{
"id": "SITE",
"type": "REPOSITORY",
"domain": "RefArch"
}
],
"startDate": "2026-03-11T14:22:15Z",
"endDate": "2026-03-11T14:22:18.442Z"
}
}

Example: successful code replication


{
"eventType": "sf.cc.replication.completed",
"timestamp": "2026-03-11T15:05:32.118Z",
"tenantId": "zzzz_prd",
"payload": {
"processId": "12347",
"uuid": "770e8400-e29b-41d4-a716-446655440002",
"type": "CodeReplicationPublication",
"targetSystem": "Development",
"state": "COMPLETED",
"isDataReplication": false,
"success": true,
"codeVersion": "version1",
"replicationGroups": [],
"startDate": "2026-03-11T15:00:00Z",
"endDate": "2026-03-11T15:05:32.118Z"
}
}

Notes

  • The description field is optional user-provided text.
  • An empty replicationGroups array indicates code-only replication.
  • Error states are machine-readable codes, not localized text. See Replication Error States.
  • Replication Group IDs
    Replication events carry one or more B2C Commerce replication groups in their payload. Each replication group identifies a unit of data that participated in the replication. Use this page to look up what a given group ID covers.
  • Replication Error States
    Failed B2C Commerce process-level replication events (sf.cc.replication.failed) include an errorState field with a machine-readable code that identifies the failure. Use this page to look up what an error state means.
 
Carregando
Salesforce Help | Article