Connect With Us

Connect with Us - notifications to valfirms

 

For the Connect with Us notifications, valfirms are expected to implement a RESTful endpoints to receive those messages:
e.g. http://valfirm.com/rest/communications

ValEx will send through those messages as HTTP POST request (with HTTP Basic Auth being expected to be utilised), with the additional parameters being passed in the request body as a JSON encoded string:

 

Example:

POST http://valfirm.com/rest/communication_added HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json
Content-Length: 78
Host: adl-sprint.valexdev.rpdata.local
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

{"job_id":5866889,"communication_id":422,"action":"Communication Notes Added"}

Once the message has been received, the valfirm is expected to pull the details on the communication from the Connect with Us webservices endpoint based on the the job and communication ID that has been provided.
ValEx will be sending the following messages to the valfirms:

Communication Requiring Response:
This is triggered when a new Message Us communication has been added and the communication has been pushed to the valfirm for actioning.

Parameters:

job_id:  The ID of the ValEx job the communication is attached to.
communication_id: The ID of the communication to be actioned.
action: “New Communication Added” (Note that the value of the parameter  is expected as a string literal – i.e. signifies the type of the notification being sent)


Communication Notes Added:
This is triggered when new notes has been added to an existing communication for which the valfirm is actioning.

 

Parameters:
job_id:  The ID of the ValEx job the communication is attached to.
communication_id: The ID of the communication for which the notes has been added.
action: “Communication Note Added” (Note that the value of the parameter  is expected as a string literal – i.e. signifies the type of the notification being sent)

 

Communication Resolved:

This is triggered once the communication has been flagged as resolved in ValEx.
This is triggered when new notes has been added to an existing communication for which the valfirm is actioning.

 

Parameters:

job_id:  The ID of the ValEx job the communication is attached to.
communication_id: The ID of the communication  which has been resolved.
action: “Communication Closed” (Note that the value of the parameter  is expected as a string literal – i.e. signifies the type of the notification being sent)