Develop > Web Service Interfaces > Event Synchronization Web Service Interface > Forward events and event changes from OPR client

Forward events and event changes from OPR client

For the OPR client to be able to forward events and event changes to a third-party event processing application, that third-party application must implement an OPR-compliant Event Synchronization Web Service.

Note You must configure a connected server before using this web service. For details, see (prerequisite) Configure a Connected Server. The <base configured URL of the connected server> is the path to the server you specified during the initial connected server setup.

Forward Event

When forwarding events from the OPR client to a third-party application, the following data is relevant:

  • HTTP Method: POST

  • Base URL: http://<base configured URL of the connected server>/event

  • Expected Payload: The expected response payload is an OprEvent object.

Forward Event Change

When forwarding event changes from the OPR client to a third-party application, the following data is relevant:

  • HTTP Method: POST

  • Base URL: http://<base configured URL of the connected server>/event_change/<external_event_ID>

  • Expected Payload: The expected response payload is an OprEventChange object.

Forward Events

When forwarding events in bulk from the OPR client to a third-party application, the following data is relevant:

  • HTTP Method: POST

  • Base URL: http://<base configured URL of the connected server>/event

  • Expected Payload: The payload is an OprEventList object.

  • Payload returned: Upon success the target service must return a list of the events sent to it with the ID set to the external Event ID. The sequence_number must match the sequence_number of the event sent in the POST. For those events which do not have a matching event returned, they are retried in a subsequent request. If an event is to be rejected, an HTTP error must be returned for the entire payload. If an HTTP error 500-599 is returned, each event is individually retried as a non-bulk request. For an HTTP error 400-499, all events in the request are marked as failed and no retry is done.

Forward Event Changes

When forwarding event changes in bulk from the OPR client to a third-party application, the following data is relevant:

  • HTTP Method: POST

  • Base URL: http://<base configured URL of the connected server>/event_change/

  • Expected Payload: The expected response payload is an OprEventChangeList object. Each OprEventChange item in the list must have the event_ref property set. The global_id is expected to be set to the ID on the target system, for example, when OMi calls this web service on the target system, the target_id is set to the OMi event ID and the target_global_id is set to the target object ID.

  • Payload returned: Upon success the target service must return a list of the event changes sent to it with the same sequence_number. The sequence_number must match the sequence_number of the event change sent in the POST. For those changes which do not have a matching change returned, they are retried in a subsequent request. If an event change is to be rejected, an HTTP error must be returned for the entire payload. If an HTTP error 500-599 is returned, each event change is individually retried as a non-bulk request. For an HTTP error 400-499, all event changes in the request are marked as failed and no retry is done.

Web Service GET Request

When there is a need to get the external event from the third-party application (for example, when the External Info tab is selected from the Event Browser), the following data is relevant:

  • HTTP Method: GET

  • Base URL: http://<base configured URL of the connected server>/event/<external_event_ID>

  • Expected Payload: The payload is the external event in the form of an OprEvent.

Web Service Ping Request

You can send a ping request to a third-party application. When sending a ping request to a third-party application, the following data is relevant:

  • HTTP Method: HEAD to base URL

  • Base URL:

    • Base URL for forwarding events: http://<base configured URL of the connected server>

  • Expected Payload: None