Newer Version Available
Recurring Activities
The master activity record in the series contains the recurrence pattern and is tracked
in a single change event. The IsRecurrence field is set to true on the master activity record.
Each occurrence in a recurring activity 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 master event record with IsRecurrence set to true. The second change event is for the first occurrence. The other occurrences are omitted in this example.
1// Change event generated for the master series.
2 {
3 "data": {
4 "schema": "3qM8RtdTpBOU8dTpXEegIw",
5 "payload": {
6 "ChangeEventHeader": {
7 "entityName": "Event",
8 "recordIds": [
9 "00UR00000031PaOMAU"
10 ],
11 "changeType": "CREATE",
12 "changeOrigin": "",
13 "transactionKey": "00145cc6-0961-8fa3-33fd-a7228e7d3a0d",
14 "sequenceNumber": 1,
15 "isTransactionEnd": false,
16 "commitTimestamp": 1513383857389,
17 "commitNumber": 8346652022727,
18 "commitUser": "005R0000000IUUMIA4"
19 },
20 "Subject": "Product Planning",
21 "Location": "Orcas Room",
22 "IsAllDayEvent": false,
23 "ActivityDateTime": "2018-02-07T18:00:00Z",
24 "ActivityDate": "2018-02-07",
25 "DurationInMinutes": 60,
26 "Description": "Let's meet to discuss product requirements.",
27 "OwnerId": "005R0000000IUUMIA4",
28 "IsPrivate": false,
29 "ShowAs": "Busy",
30 "IsChild": false,
31 "IsGroupEvent": false,
32 "GroupEventType": "0",
33 "CreatedDate": "2017-12-16T00:24:17Z",
34 "CreatedById": "005R0000000IUUMIA4",
35 "LastModifiedDate": "2017-12-16T00:24:17Z",
36 "LastModifiedById": "005R0000000IUUMIA4",
37 "IsArchived": false,
38 "RecurrenceActivityId": "00UR00000031PaOMAU",
39 "IsRecurrence": true,
40 "RecurrenceStartDateTime": "2018-02-07T18:00:00Z",
41 "RecurrenceEndDateOnly": "2018-03-07",
42 "RecurrenceTimeZoneSidKey": "America/Los_Angeles",
43 "RecurrenceType": "RecursWeekly",
44 "RecurrenceInterval": 1,
45 "RecurrenceDayOfWeekMask": 8,
46 "ReminderDateTime": "2018-02-07T17:45:00Z",
47 "IsReminderSet": true
48 },
49 "event": {
50 "replayId": 7
51 }
52 },
53 "channel": "/data/ChangeEvents"
54}
55
56// Change event generated for the first occurrence.
57{
58 "data": {
59 "schema": "3qM8RtdTpBOU8dTpXEegIw",
60 "payload": {
61 "ChangeEventHeader": {
62 "entityName": "Event",
63 "recordIds": [
64 "00UR00000031PaPMAU"
65 ],
66 "changeType": "CREATE",
67 "changeOrigin": "",
68 "transactionKey": "00145cc6-0961-8fa3-33fd-a7228e7d3a0d",
69 "sequenceNumber": 2,
70 "isTransactionEnd": false,
71 "commitTimestamp": 1513383857389,
72 "commitNumber": 8346652022727,
73 "commitUser": "005R0000000IUUMIA4"
74 },
75 "Subject": "Product Planning",
76 "Location": "Orcas Room",
77 "IsAllDayEvent": false,
78 "ActivityDateTime": "2018-02-07T18:00:00Z",
79 "ActivityDate": "2018-02-07",
80 "DurationInMinutes": 60,
81 "Description": "Let's meet to discuss product requirements.",
82 "OwnerId": "005R0000000IUUMIA4",
83 "IsPrivate": false,
84 "ShowAs": "Busy",
85 "IsChild": false,
86 "IsGroupEvent": false,
87 "GroupEventType": "0",
88 "CreatedDate": "2017-12-16T00:24:17Z",
89 "CreatedById": "005R0000000IUUMIA4",
90 "LastModifiedDate": "2017-12-16T00:24:17Z",
91 "LastModifiedById": "005R0000000IUUMIA4",
92 "IsArchived": false,
93 "RecurrenceActivityId": "00UR00000031PaOMAU",
94 "IsRecurrence": false,
95 "ReminderDateTime": "2018-02-07T17:45:00Z",
96 "IsReminderSet": true
97 },
98 "event": {
99 "replayId": 8
100 }
101 },
102 "channel": "/data/ChangeEvents"
103}