Notification Parameters

Data

Object

Provides the new representation of the modified User, Team, Dialog, Queue, User/Queues, or Media object. This information is not provided when a user is deleted.

For a Dialog or Media Error notification, provides the list of ApiError objects that represent the failure conditions detected by the server.

The entire User, Team, Dialog, Queue, or Media object in its most current, updated form.

The Team object includes all of its agents.

For the User/Queues object, specifies a list of queues that were added or deleted from the user's list.

Event

String

The type of modification that occurred to the User, Team, Dialog, Queue, User/Queues, or Media object.

PUT: A property of the User, Dialog, Team, Queue, or Media object that was modified.

DELETE: A User, Dialog, Team, Queue, or Media object has been deleted. For a User/Queues modification, the queues removed from the user's list of queues.

POST: A User, Dialog, Team, Queue, or Media object has been added. For a User/Queues modification, specifies the queues that were added to the user's list of queues.

Source

String

The resource location for the User, Dialog, Team, Queue, User/Queues, or Media object that was modified.

/finesse/api/User/{id}

/finesse/api/Dialog/{id}

/finesse/api/Team/{id}

/finesse/api/User/{id}/Dialogs

/finesse/api/User/{id}/Dialogs/Media

/finesse/api/Queue/{id}

/finesse/api/User/{id}/Queues

/finesse/api/User/{id}/Media

RequestId

String

The requestId that was returned when the triggering REST API request was made. If the event was unsolicited, this tag is empty. This tag is empty for a User/Queues notification.

An opaque, unique string, used to correlate the originating request with the resulting event