The Event object

Events are generated by some Voxity resources when important actions occurred in your agent. When this happens, a new Event object is created.

For a list of event types, including sample events, see the section Event types. Events are represented as JSON objects and they all have a similar structure, and the same top-level fields.

The following fields appear in all events sent by Voxity and comprise the Event object.

{
    "version": "0",
    "id": "event identifier",
    "type": "event name",
    "agentId": "event agent",
    "description": "event description",
    "createdAt": "event date and time",
    "data": {
        "object": {
            JSON Object
        },
        "previousAttributes": {
            JSON Object
        }
    }
}

Attributes

Name	Type	Description
version	string	By default, this is set to "0" in all events.
id	string	Unique identifier for the event.
type*	string	Type of the event (e.g. customer.created).
agentId*	string	The ID of the agent associated with the event.
description	string	A human readable description of the event.
createdAt	string	The date and time (in UTC ISO 8601 format) when the event was created.
data*	object	An object that contains information about the event.
data.object*	object	Object containing the API resource relevant to the event.
data.previousAttributes	object	Object containing the names of the updated attributes and their values prior to the event.

The contents of the data field are different depending of the event type. For examples of events generated, see Event types.