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.

SvcApptSchdEvent

Represents the service appointment event. This object is included in a streamed notification received on the channels for the parent platform events. You can’t subscribe to the SvcApptSchdEvent channel directly. This object is available in API version 50.0 and later.

Supported Calls

describeSObjects()

Parent Platform Events

AppointmentSchedulingEvent
ServiceAppointmentEvent

Fields

Field	Details
AdditionalInformation	Type string Properties Nillable Description Additional information about the service appointment.
Address	Type string Properties Nillable Description The address of the service appointment.
AppointmentType	Type string Properties Nillable Description The service appointment type.
ChangedFields	Type complexvalue Properties Nillable Description List of fields that changed.
Comments	Type string Properties Nillable Description Comments about the service appointment.
ContactId	Type string Properties Nillable Description ID of the contact associated with the service appointment.
DurationInMinutes	Type double Properties Nillable Description The duration of the service appointment in minutes.
Email	Type string Properties Nillable Description The email associated with the service appointment.
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.
ParentRecordId	Type string Properties Nillable Description ID of the parent record associated with the service appointment.
Phone	Type string Properties Nillable Description The phone number associated with the service appointment.
ScheduledEndTime	Type dateTime Properties Nillable Description The scheduled end time of the service appointment.
ScheduledStartTime	Type dateTime Properties Nillable Description The scheduled start time of the service appointment.
ServiceAppointmentId	Type string Properties Nillable Description ID of the service appointment.
ServiceTerritoryId	Type string Properties Nillable Description ID of the service territories associated with the service appointment.
Status	Type string Properties Nillable Description The status of the service appointment.
StatusCategory	Type string Properties Nillable Description The status category of the service appointment.
Subject	Type string Properties Nillable Description The subject of the service appointment.
WorkTypeBlockTimeAfterAppointment	Type int Properties Nillable Description The period of time occurring after the appointment that is typically blocked for this work type.
WorkTypeBlockTimeAfterUnit	Type string Properties Nillable Description The unit of the period specified for WorkTypeBlockTimeAfterAppointment. Values include `hour` and `minute`.
WorkTypeBlockTimeBeforeAppointment	Type int Properties Nillable Description The period of time occurring before the appointment that is typically blocked for this work type.
WorkTypeBlockTimeBeforeUnit	Type string Properties Nillable Description The unit of the period specified for WorkTypeBlockTimeBeforeAppointment. Values include `hour` and `minute`.
WorkTypeId	Type string Properties Nillable Description ID of the work type associated with the service appointment.

Example

This example shows the service appointment fields associated with the event.

1{
2  "ParentRecordId": "001RM000003rwkfYAA",
3  "ContactId": "003RM000006EpajYAC",
4  "Status": "None",
5  "AdditionalInformation": "Sample additional information",
6  "ServiceTerritoryId": "0Hhxx0000004mu4",
7  "Comments": "Sample comment",
8  "Email": "abc@example.com",
9  "Address": "1 Market Street San Francisco CA 94105 United States",
10  "WorkTypeId": "08qxx0000004C92",
11  "WorkTypeBlockTimeBeforeAppointment": 30,
12  "WorkTypeBlockTimeAfterAppointment": 1,
13  "WorkTypeBlockTimeBeforeUnit": "minutes",
14  "WorkTypeBlockTimeAfterUnit": "hours",
15  "ServiceAppointmentId": "08pxx0000005Ip6",
16  "ScheduledEndTime": "2020-02-28T00:45:00.000Z",
17  "Subject": "Apply for Chase Sapphire Preferred Card",
18  "AppointmentType": "null",
19  "StatusCategory": "None",
20  "DurationInMinutes": 60,
21  "Phone": "4157286216",
22  "ScheduledStartTime": "2020-02-27T23:45:00.000Z"
23}

Platform Events Developer Guide

SvcApptSchdEvent

Supported Calls

Parent Platform Events

Fields

Example