Event Contexts

In this article we’ll cover the context categories that are available depending on the specific Gnatta workflow event that has been triggered.

For more information about events themselves, check this article: Events or if you’re not sure what context is, start here: Contextual Data

List of events

To navigate to the event you’re interested in, select it from the list below:

1 Call Ended
2 Call Started
3 Chat Ended
4 Chat Started
5 Chat Survey Completed
6 Contact Form Received
7 Conversation Created
8 Data Updated
9 External HTTP Request
10 Interaction Assigned
11 Interaction Closed
12 Message Sent
13 New Message Received
14 Note Added
15 Queue Changed
16 Response Received
17 Thread Control Received
18 User State Changed

Call Ended

[back to list]

When this event is triggered, the following context categories are available:

Interaction
Conversation
- Person
Echo
- Person

Call Started

[back to list]

When this event is triggered, the following context categories are available:

Conversation
- Person
Echo
- Person

Chat Ended

[back to list]

When this event is triggered, the following context categories are available:

Interaction
Conversation
- Person

Chat Started

[back to list]

When this event is triggered, the following context categories are available:

Conversation
- Person
Chat Data

Chat Survey Completed

[back to list]

When this event is triggered, the following context categories are available:

Interaction
Chat Data

Contact Form Received

[back to list]

When this event is triggered, the following context categories are available:

Conversation
- Person
Echo
- Person
Chat Data

Conversation Created

[back to list]

When this event is triggered, the following context categories are available:

Interaction
Conversation
- Person

Data Updated

[back to list]

When this event is triggered, the following context categories are available:

Interaction
Conversation
- Person

And the following additional contexts, which are not in the main context library:

Name	Shortcode	Data

Name	Shortcode	Data
Updated Data Field ID	UpdatedDynamicDataTypeId	The GUID of the data field that has been updated.
Data Field Updated By [User]	UpdatedDynamicDataTypeUser	The user who changed the data field.

External HTTP Request

[back to list]

Context on this event works differently to other events, as it varies depending on the content of the request itself. HTTP requests should be formatted to match context properties as shown in the example below. The data that is passed in the request body will then be converted and stored into the relevant contexts. For example:

{
  "echo": {
    "channel": "Email",
    "body": "Content goes here"
  },
  "conversation": {
    "channel": "Email",
    "person": {
      "email": {
        "address": "forename.surname@example.com",
        "name": "Forname Surname"
      }
    }
  }
}

In this request, Content goes here will be stored in Echo.Body and forename.surname@example.com will be stored in Conversation.Person.Email.Address for example. This will apply to all data passed in the HTTP request, provided the request is formatted correctly per the available contexts and categories found in our glossary.

Additionally, each External HTTP Request event will also collect the following context, which is not part of the main context library:

Name	Shortcode	Data

Name	Shortcode	Data
HTTP Request Body	RawExternalHttpRequest	The JSON representation of the original request body, which can be useful for debugging purposes.

Interaction Assigned

[back to list]

When this event is triggered, the following context categories are available:

Interaction

Interaction Closed

[back to list]

When this event is triggered, the following context categories are available:

Interaction

Message Sent

[back to list]

When this event is triggered, the following context categories are available:

Interaction
Conversation
- Person
Echo
- Person

New Message Received

[back to list]

When this event is triggered, the following context categories are available:

Conversation
- Person
Echo
- Person

Note that the circumstances in which a New Message Received event will trigger vs a Response Received event is nuanced depending on the channel at hand - check this for more information: Find or Create Interactions | Channel differences