Platform Events Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Platform Events Developer Guide
Delivering Custom Notifications with Platform Events
Defining Your Custom Platform Event
Publishing Platform Events
Subscribing to Platform Events
Testing Your Platform Event in Apex
Encrypting Platform Event Messages at Rest in the Event Bus
Monitor Platform Event Publishing and Delivery Usage
Considerations
Examples
Reference
Platform Event Allocations
Platform Event Error Status Codes
Standard Platform Event Objects
Change Data Capture Events
Standard Platform Event Object List
AcademicTermGpaCalcEvent
AIPredictionEvent
AIUpdateRecordEvent
AppointmentSchedulingEvent
AssetCancelInitiatedEvent
AssetAmendInitiatedEvent
AssetRenewInitiatedEvent
AssetTokenEvent
BatchApexErrorEvent
BillingScheduleCreatedEvent
BulkApi2JobEvent (Beta)
CommerceDiagnosticEvent
ConsentEvent
ConsentUnsubscribeAllEvent
ConversationInsightEvent
CreateAssetOrderEvent
CreditInvoiceProcessedEvent
CreditMemoProcessedEvent
DataObjectDataChgEvent
DataObjectMetadataChgEvent
DatasetExportEvent
DiscoveryPredictionEvent
EmailCapturedMatchEvent
ExtlRecShrEvent
ExtlRecShrResultEvent
FirstBillPaymentSetupEvent
FlowExecutionErrorEvent
FlowOrchestrationEvent
FOStatusChangedEvent
FulfillOrdItemQtyChgEvent
InsPolicyRnwlQuoteStatusEvent
InsPolicyRnwlStatusEvent
InteropTopicSubcrEvent
InvoiceProcessedEvent
InvoiceProcPymtExclEvent
NegInvcLineProcessedEvent
OmniTrackingEvent
OrderStatusChangedEvent
OrderSummaryCreatedEvent
OrderSumStatusChangedEvent
PaymentCreationEvent
PendingOrdSumProcEvent
PlaceOrderCompletedEvent
PlatformStatusAlertEvent
ProcessExceptionEvent
QuoteSaveEvent
QuoteToOrderCompletedEvent
RealtimeAlertEvent
RemoteKeyCalloutEvent
SrcPredJobStatusChgEvent
SearchIndexJobStatusEvent
ServiceAppointmentEvent
VoidInvoiceProcessedEvent
WebCartAbandonedEvent
WebStoreUserCreatedEvent
Real-Time Event Monitoring Objects
ApiAnomalyEvent
ApiAnomalyEventStore
ApiEvent
ApiEventStream
BulkApiResultEvent
BulkApiResultEventStore
ConcurLongRunApexErrEvent
CredentialStuffingEvent
CredentialStuffingEventStore
CreditInvoiceProcessedEvent
CreditMemoProcessedEvent
CrMemoProcessErrDtlEvent
GuestUserAnomalyEvent
GuestUserAnomalyEventStore
PaymentCreationEvent
VoidInvoiceProcessedEvent
FileEvent
FileEventStore
IdentityProviderEventStore
IdentityVerificationEvent
LightningUriEvent
LightningUriEventStream
ListViewEvent
ListViewEventStream
LoginAnomalyEvent
LoginAnomalyEventStore
LoginAsEvent
LoginAsEventStream
LoginEvent
LoginEventStream
LogoutEvent
LogoutEventStream
MobileEmailEvent
MobileEnforcedPolicyEvent
MobileScreenshotEvent
MobileTelephonyEvent
PermissionSetEvent
PermissionSetEventStore
ReportAnomalyEvent
ReportAnomalyEventStore
ReportEvent
ReportEventStream
SessionHijackingEvent
SessionHijackingEventStore
UriEvent
UriEventStream
PDF

MobileTelephonyEvent

Tracks your users’ phone calls and text messages in a Salesforce mobile app with Enhanced Mobile Security. This object is available in API version 47.0 and later.

Use the Mobile Security SDK to publish these events. Learn more with the Mobile Application Security help documentation.

Supported Calls

create(), describeSObjects()

Supported Subscribers

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

Subscription Channel

/event/MobileTelephonyEvent

Special Access Rules

Accessing this object requires the Enhanced Mobile App Security and Salesforce Event Monitoring add-on subscriptions and the Enforce Enhanced Mobile App Security user permission.

As of Summer ’20 and later, only authenticated internal and external users can access this object.

Event Delivery Allocation Enforced

No

Fields

Field Details
AppPackageIdentifier
Type
string
Properties
Create
Description
Generic package identifier for the application.
AppVersion
Type
string
Properties
Create
Description
Version number of the application.
DeviceIdentifier
Type
string
Properties
Create
Description
Unique identifier for the device. Generated by Apple® or Google™.
DeviceModel
Type
string
Properties
Create
Description
Model name of the device.
EventDate
Type
dateTime
Properties
Create, Nillable
Description
Date of the mobile event. For example, 2020-01-20T19:12:26.965Z. Milliseconds are the most granular setting.
EventDescription
Type
string
Properties
Create, Nillable
Description
Description of the mobile event.
EventIdentifier
Type
string
Properties
Create, Nillable
Description
The unique ID of the event, which is shared with the corresponding storage object, if any. For example, 0a4779b0-0da1-4619-a373-0a36991dff90.
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.
Operation
Type
picklist
Properties
Create, Restricted picklist
Description
Type of operation that triggered the event.
Possible values are:
  • PhoneCall
  • SMS
OsName
Type
string
Properties
Create
Description
Name of the operating system.
OsVersion
Type
string
Properties
Create
Description
Version number of the operating system.
PhoneNumber
Type
string
Properties
Create
Description
Phone number for the recipient of the phone call or text message.
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.
UserId
Type
reference
Properties
Create, Namepointing
Description
ID of the user who triggered the event.
WebkitVersion
Type
string
Properties
Create, Nillable
Description
Version of WebKit™ used to render web components.