Team Notification

Finesse sends a team notification when the agent name or agent state changes for an agent who belongs to that team.

Format:

XML

Node:

/finesse/api/Team/{id}/Users

Source:

/finesse/api/User/{id}

Data:

Summary version of the User object

Payload:

Code Snippet
Copy<Update>
    <event>{put}</event>
    <source>/finesse/api/User/{id}</source>
    <requestId>xxxxxxxxx</requestId>
    <data>
        <user>
            <uri>/finesse/api/User/{id}</uri>
            <loginId>{id}</loginId>
            <firstName>Jack</firstName>
            <lastName>Brown</lastName>
            <state>NOT_READY</state>
            <stateChangeTime>2012-03-01T17:58:21.123Z</stateChangeTime>
            <ReasonCode>
                <uri>finesse/api/ReasonCode/1</uri>
                <code>10</code>
                <label>Team Meeting</label>
                <category>NOT_READY</category>
                <id>1</id>
            </ReasonCode>
        </user>
    </data>
</Update>

Sample Notification Payload:

Code Snippet
Copy<Update>
    <event>put</event>
    <source>/finesse/api/Team/1004</source>
    <requestId>xxxxxxxxx</requestId>
    <data>
        <team>
            <uri>/finesse/api/Team/1004</uri>
            <id>1004</id>
            <name>Shiny</name>
            <users>
                <User>
                    <uri>/finesse/api/User/1234</uri>
                    <loginId>1004</loginId>
                    <firstName>Charles</firstName>
                    <lastName>Norrad</lastName>
                    <pendingState></pendingState>
                    <state>LOGOUT</state>
                    <stateChangeTime>2012-03-01T17:58:21.123Z</stateChangeTime>
                </User>
                <User>
                    <uri>/finesse/api/User/9876</uri>
                    <loginId>9876</loginId>
                    <firstName>Jack</firstName>
                    <lastName>Brown</lastName>
                    <state>NOT_READY</state>
                    <stateChangeTime>2012-03-01T17:58:21.134Z</stateChangeTime>
                    <ReasonCode>
                        <uri>/finesse/api/ReasonCode/1</uri>
                        <code>10</code>
                        <label>Team Meeting</label>
                        <category>NOT_READY</category>
                        <id>1</id>
                    </ReasonCode>
                </User>
           ... other users ...
            </users>
        </team>
    </data>
</Update>

Notification Triggers:

  • Agent name is changed for an agent who belongs to the team
  • Agent state is changed for an agent who belongs to the team