Recurring Activities

The activity series record is tracked in a single change event. Each occurrence in the series is tracked by an individual change event.

Example

These two change events are generated when creating a recurring calendar event. The first change event is for the event series record, which represents the recurrence pattern, with GroupEventType set to 3. The second change event is for the first occurrence. The other occurrences are omitted in this example.

1// Change event generated for the event series record.
2{
3  "schema": "FNhgkGvYpb6gdvt_vSkpBw",
4  "payload": {
5    "LastModifiedDate": "2019-08-05T18:44:33.000Z",
6    "Description": "Let's meet to discuss product requirements.",
7    "ActivityDate": "2019-08-12",
8    "IsRecurrence": false,
9    "Recurrence2PatternVersion": "1",
10    "GroupEventType": "3",
11    "Subject": "Product Planning",
12    "ActivityDateTime": "2019-08-12T19:00:00.000Z",
13    "DurationInMinutes": 60,
14    "OwnerId": "005RM000001iKYtYAM",
15    "CreatedById": "005RM000001iKYtYAM",
16    "IsAllDayEvent": false,
17    "ChangeEventHeader": {
18      "commitNumber": 59038718735,
19      "commitUser": "005RM000001iKYtYAM",
20      "sequenceNumber": 1,
21      "entityName": "Event",
22      "changeType": "CREATE",
23      "changedFields": [],
24      "changeOrigin": "com/salesforce/api/soap/47.0;client=SfdcInternalAPI/",
25      "transactionKey": "0001856c-ee5d-c295-dc83-75575ad684a6",
26      "commitTimestamp": 1565030673000,
27      "recordIds": [
28        "00URM000001W22b2AC"
29      ]
30    },
31    "IsChild": false,
32    "CreatedDate": "2019-08-05T18:44:33.000Z",
33    "IsReminderSet": false,
34    "ActivityRecurrence2Id": "828RM000000010WYAQ",
35    "IsPrivate": false,
36    "LastModifiedById": "005RM000001iKYtYAM",
37    "IsRecurrence2Exclusion": false,
38    "Recurrence2PatternText": "RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO;COUNT=13",
39    "Location": "Orcas Room",
40    "ShowAs": "Busy",
41    "IsGroupEvent": false
42  },
43  "event": {
44    "replayId": 25
45  }
46}
47
48// Change event generated for the first occurrence.
49{
50  "schema": "FNhgkGvYpb6gdvt_vSkpBw",
51  "payload": {
52    "LastModifiedDate": "2019-08-05T18:44:37.000Z",
53    "Description": "Let's meet to discuss product requirements.",
54    "ActivityDate": "2019-08-12",
55    "IsRecurrence": false,
56    "Recurrence2PatternVersion": "1",
57    "GroupEventType": "0",
58    "Subject": "Product Planning",
59    "ActivityDateTime": "2019-08-12T19:00:00.000Z",
60    "DurationInMinutes": 60,
61    "OwnerId": "005RM000001iKYtYAM",
62    "CreatedById": "005RM000001iKYtYAM",
63    "IsAllDayEvent": false,
64    "ChangeEventHeader": {
65      "commitNumber": 59038718735,
66      "commitUser": "005RM000001iKYtYAM",
67      "sequenceNumber": 2,
68      "entityName": "Event",
69      "changeType": "CREATE",
70      "changedFields": [],
71      "changeOrigin": "com/salesforce/api/soap/47.0;client=SfdcInternalAPI/",
72      "transactionKey": "0001856c-ee5d-c295-dc83-75575ad684a6",
73      "commitTimestamp": 1565030677000,
74      "recordIds": [
75        "00URM000001W22c2AC"
76      ]
77    },
78    "IsChild": false,
79    "CreatedDate": "2019-08-05T18:44:37.000Z",
80    "IsReminderSet": false,
81    "ActivityRecurrence2Id": "828RM000000010WYAQ",
82    "IsPrivate": false,
83    "LastModifiedById": "005RM000001iKYtYAM",
84    "IsRecurrence2Exclusion": false,
85    "Recurrence2PatternText": "RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO;COUNT=13",
86    "Location": "Orcas Room",
87    "ShowAs": "Busy",
88    "IsGroupEvent": false
89  },
90  "event": {
91    "replayId": 26
92  }
93}

Change Data Capture Developer Guide

Recurring Activities

Example