User Notification

Finesse sends a User notification when information about a user changes.

Format:

XML

Node:

/finesse/api/User/{id}

Source:

/finesse/api/User/{id}

Data:

User

Payload:

Code Snippet
Copy
<Update>
   <event>{put|delete}</event>
   <source>/finesse/api/User/{id}</source>
   <data>
      <user>
      <!-- full User object -->
      </user>
   </data>
</Update>

Sample Notification Payload:

Code Snippet
Copy
<Update>
   <event>put</event>
   <source>/finesse/api/User/csmith</source>
   <data>
      <User>
        <dialogs>/finesse/api/User/1001001/Dialogs</dialogs>
        <extension></extension>
        <firstName>AGENT</firstName>
        <lastName>1001001</lastName>
        <loginId>1001001</loginId>
        <loginName>agent1</loginName>
        <pendingState></pendingState>
        <reasonCodeId>2</reasonCodeId>
        <ReasonCode>
          <uri>/finesse/api/ReasonCode/{id}</uri>
          <code>10</code>
          <label>Team Meeting</label>
        </ReasonCode>
        <settings>
          <wrapUpOnIncoming>OPTIONAL</wrapUpOnIncoming>
          <wrapUpOnOutgoing>REQUIRED</wrapUpOnOutgoing>
        </settings>
        <roles>
          <role>Agent</role>
        </roles>
        <state>LOGOUT</state>
        <stateChangeTime></stateChangeTime>
        <teamId>5000</teamId>
        <teamName>FunctionalAgents</teamName>
        <uri>/finesse/api/User/1001001</uri>
      </User>
   </data>
</Update>

Notification Triggers:

  • Addition of a user

    Addition of a user

  • Deletion of a user

  • State change

  • First or last name change

  • Role change

  • Pending state change