Salesforce Docs Portal

Vehicle Telematics Business API and Platform Events

There are different methods to bring telematics events into Automotive Cloud and execute actions on the event. Use the Actionable Orchestration Source Event platform event to publish events or use the Orchestration Inbound Events business API to trigger events. The platform event and the business API can be easily integrated with any telematics provider system.

Required Editions

Available in: Enterprise, Unlimited, and Developer Editions

Here’s the process to use the platform event framework to ingest events. For details, see Platform Events Developer Guide

  • Phase 1 - Prepare Input Data: The request payload must contain the source system identifier and event type at a minimum. In addition, event subtype and event category can also be specified. For additional events data, make sure the JSON structure matches the nodes and attributes for a context definition.
  • Phase 2 - Publish the Source Event: Publish the Actionable Orchestration Source Event platform event from an external app so that you can establish the connection between the telematics provider and Salesforce. Salesforce receives all events originating in the telematics system after the platform event is published.
  • Phase 3 - Subscribe to the Response Event: Subscribe to the Actionable Orchestration Response Event platform event so that the external system is notified after an action is executed for the source event. The response contains the details of the executed action, the processing status of the source event, and the error description for a failed event.

Here are the high-level steps that must be performed if you use the business API to ingest events. For details, see Orchestration Events (POST)

  • Prepare Input Data: The request payload must contain the source system identifier and event type at a minimum. In addition, event subtype and event category can also be specified. For additional events criteria, make sure the JSON structure specifies the key-value pairs for each type of detail you want to specify.
  • Trigger the API: Use a POST method to trigger the API that automatically invokes the actionable event orchestration framework.
  • Review the Results: Review the response of the API that lists the actions taken by the orchestration process for a specified event. The response contains the details of the executed action, the processing status of the source event, and the error description for a failed event.
Note
Note While preparing the input data, if you edit your input mappings for a context definition, make sure your input payload's event data has the input mapping names that you provided. It should not have the node names. Also, make sure to provide values for all the input mappings for the attributes.
Example
Example

For example, if the input mapping for an Event node is Asset, the input payload should look like this:

{

 "sourceSystemIdentifier": "5566315809",

 "type": "WorkshopEvent",

 "eventData": "{"Asset":[{"assetId":"02i5Y00000ZJ5zPQAT","signals":[{"thresholds":[{"lower":1200,"upper":1900}]}]}]}"

}