How do you correlate the REST API requests to the notifications?

If you want to correlate your REST API request to the matching Finesse notification response, you will need to add the 'requestId' attribute to the HTTP header of the REST request to Finesse. The value of the requestId should be a unique string, which will help with the correlation. When the HTTP response or notification is sent to the requester, it will contain the given requestId.

For example:

If you make a HTTP request to sign in an agent with a requestId of xyz, the notification that will be sent to the User node will contain the xyz value in the requestId tag:

<Update>
    <data>
        <user>
            <dialogs>/finesse/api/User/1234/Dialogs</dialogs>
            <extension>1001</extension>
            <firstName>John</firstName>
            <lastName>Smith</lastName>
            <loginId>1234</loginId>
            <loginName>jsmith</loginName>
            <roles>
                <role>Agent</role>
            </roles>
            <pendingState></pendingState>
            <reasonCodeId>-1</reasonCodeId>
            <settings>
                <wrapUpOnIncoming></wrapUpOnIncoming>
            <settings>
                <state>NOT_READY</state>
                <stateChangeTime>2014-05-27T00:33:44.836Z</stateChangeTime>
                <teamId>1</teamId>
                <teamName>Default</teamName>
                <uri>/finesse/api/User/1234</uri>
            </settings>
        </user>
    </data>
    <event>PUT</event>
    <requestId>xyz</requestId>
    <source>/finesse/api/User/1234</source>
</Update>