Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

AppointmentSchedulingEvent

Notifies subscribers when an appointment schedule is added, updated, or deleted. This object is available in API version 50.0 and later.

Supported Calls

describeSObjects()

Special Access Rules

AppointmentSchedulingEvent is available as part of Salesforce Scheduler.

Supported Subscribers

Subscriber	Supported?
Apex Triggers
Flows
Processes
Pub/Sub API
Streaming API (CometD)

Subscription Channel

/event/AppointmentSchedulingEvent

Event Delivery Allocation Enforced

Yes

Fields

Field	Details
AssignedResourceFields	Type AsgnRsrcApptSchdEvent[] Properties Nillable Description The assigned resources associated with the appointment.
ChangeType	Type string Properties Nillable Description The operation that caused the change. For example: CREATE, UPDATE, DELETE.
CorrelationId	Type string Properties Nillable Description The universally unique identifier (UUID) that correlates the appointment with the platform event.
EventUuid	Type string Properties Nillable Description A universally unique identifier (UUID) that identifies a platform event message. This field is available in API version 52.0 and later.
ReplayId	Type string Properties Nillable Description Represents an ID value that is populated by the system and refers to the position of the event in the event stream. Replay ID values aren’t guaranteed to be contiguous for consecutive events. A subscriber can store a replay ID value and use it on resubscription to retrieve missed events that are within the retention window.
ServiceAppointmentFields	Type SvcApptSchdEvent[] Properties Nillable Description The service appointments associated with the appointment.

Example

This example event message is for a new appointment with two assigned resources.

1{
2  "schema": "Zog7FKcPWV9DeEIEVHsoug",
3  "payload": {
4    "CreatedById": "005xx000001X7dlAAC",
5    "ChangeType": "CREATE",
6    "ServiceAppointmentFields": {
7      "ParentRecordId": "001RM000003rwkfYAA",
8      "ContactId": "003RM000006EpajYAC",
9      "Status": "None",
10      "AdditionalInformation": "Sample additional information",
11      "ServiceTerritoryId": "0Hhxx0000004mu4",
12      "Comments": "Sample comment",
13      "Email": "abc@example.com",
14      "Address": "1 Market Street San Francisco CA 94105 United States",
15      "WorkTypeId": "08qxx0000004C92",
16      "WorkTypeBlockTimeBeforeAppointment": 30,
17      "WorkTypeBlockTimeAfterAppointment": 1,
18      "WorkTypeBlockTimeBeforeUnit": "minutes",
19      "WorkTypeBlockTimeAfterUnit": "hours",
20      "ServiceAppointmentId": "08pxx0000005Ip6",
21      "ScheduledEndTime": "2020-02-28T00:45:00.000Z",
22      "Subject": "Apply for Privileged Customer Card",
23      "AppointmentType": "null",
24      "StatusCategory": "None",
25      "DurationInMinutes": 60,
26      "Phone": "4155551212",
27      "ScheduledStartTime": "2020-02-27T23:45:00.000Z"
28    },
29    "AssignedResourceFields": [
30      {
31        "IsPrimaryResource": true,
32        "ServiceResourceUserName": "Rachel Adams",
33        "ServiceResourceUserId": "005xx000001X7dl",
34        "AssignedResourceId": "03rxx0000004gLc",
35        "ServiceResourceId": "0Hnxx0000004C92",
36        "ServiceResourceUserEmail": "ra@example.com",
37        "IsRequiredResource": true
38      },
39      {
40        "IsPrimaryResource": false,
41        "ServiceResourceUserName": "Andrew Collins",
42        "ServiceResourceUserId": "005xx000001XPNl",
43        "AssignedResourceId": "03rxx0000004gNE",
44        "ServiceResourceId": "0Hnxx0000006z8q",
45        "ServiceResourceUserEmail": "ac@example.com",
46        "IsRequiredResource": false
47      }
48    ],
49    "CreatedDate": "2020-02-25T01:57:39.936Z",
50    "CorrelationId": "d7c0bbGiUObLF6BD3NaG"
51  },
52  "event": {
53    "replayId": 3
54  }
55}

Platform Events Developer Guide