1. Understanding Field Service APIs
  2. Outbound API

Outbound API

Outbound API is used for interaction between the Oracle Field Service message engine and external Client Application. Client Application is a software that is developed to integrate Oracle Field Service with external system(s). Client Application SOAP Service implements the following operations called by Oracle Field Service:

  • Send messages to Client Application.

  • Check if the message is still being processed.

  • Remove message from the agent internal queue, if the need in such message no longer present.

  • Optionally changing properties of an activity and/or activity status.Update or delete specific inventory in Oracle Field Service.

    Detailed information on the methods used by Outbound API can be found in the corresponding Outbound Interface API guide.

    Detailed information on configuring the outbound messages can be found in the Notification Configuration Guide. The recommended use for the Outbound Interface is for time-based notifications (for example, notifications to customers) typically using the Reminder and Change notification triggers. For all other system events (for example, Route changes, Activity status changes, Inventory changes, Service Request changes, and so on), it is recommended to use the Core API/Events REST API for integration.