Events
Overview
Events are logs of events or actions that occur. For example, when an entity fact is updated, an event is created and specifies when the event was created, by which login user and the type of event.
Events can exist on Entities, Case, Policy, Offer, Templates.
For a full list of supported fields for each type please visit our Playground.
| Fields | Type | Details |
|---|---|---|
| id | String | Unique identifier of event |
| by | Login | A login user. |
| timestamp | DateTime | Date and time when the event occured |
| type | String | Type of event that occured |
Fetching a list of Events
Example query of field events in type individuals:
query individuals {
individuals {
list {
id
events {
id
by {
associatedUser {
name
}
email
}
timestamp
type
}
}
}
}
Example result:
{
"data": {
"individuals": {
"list": [
{
"id": "60d584bd-84f9-45b5-b3d8-2cd8bb707e22",
"events": [
{
"id": "a5a57213-ecb6-4e47-a5f0-cc994cad0c64",
"by": {
"associatedUser": {
"name": "<Name of login user>"
},
"email": "[email protected]"
},
"timestamp": "2020-05-21T04:40:08.355Z",
"type": "addFact"
},
{
"id": "f9e2d6da-562e-4726-9b38-b79ace5ac78b",
"by": {
"associatedUser": {
"name": "<Name of login user>"
},
"email": "[email protected]"
},
"timestamp": "2020-05-21T04:40:08.355Z",
"type": "addAddress"
},
{
"id": "dce55931-05f6-4a3e-a51e-bde3daa1b2b2",
"by": {
"associatedUser": {
"name": "<Name of login user>"
},
"email": "[email protected]"
},
"timestamp": "2020-08-27T11:29:13.362Z",
"type": "updateIdentity"
}
]
}
]
}
}
}
Example query of field events in type policies:
query policies {
policies {
list {
events {
type
timestamp
by {
associatedUser {
name
}
email
}
}
}
}
}
Example query of field events in type logins:
query logins {
logins {
list {
events {
type
timestamp
by {
associatedUser {
name
}
email
}
}
}
}
}
Example query of field events in type cases:
query cases {
cases {
list {
events {
type
timestamp
by {
associatedUser {
name
}
email
}
}
}
}
}