Event Macros
Event macros are slightly different to regular Natterbox macros in that they are dependent on the context of which event has fired and what data is available within that Event, typically this is based around the category the type of Event belongs to. For example in a Wrap-Up based event this will not have data around the date/time of a specific message but a Message event will have this data.
This means that we need to consider the type of event that has been triggered to identify what data we have available to us.
See below for more information on the different categories of events and the sorts of data that is available.
Conversation Events
Event Data | Data Description | Macro |
|---|---|---|
Conversation Id | The unique identifier of the conversation. | $(Payload_Event.event.conversationId) |
Status | The current status of the conversation. | $(Payload_Event.event.status) |
Message Events
Event Data | Data Description | Macro | |
|---|---|---|---|
Message Info | Channel Type | The channel type of the message. For example, “SMS” or “WhatsApp”. | $(Payload_Event.event.messageInfo.channelType) |
Message payload | The contents of the message itself that was sent. | $(Payload_Event.event.messagePayLoad.textMessage.text) | |
Digital Channel Address | The digital channel address, sometimes referred to as the From Address. This is typically the Agents address. | $(Payload_Event.event.messageInfo.digitalChannelAddress) | |
Identity Address | The identity address, sometimes referred to as the To Address. This is typically the Customer or Contacts address that the agent is conversing with. | $(Payload_Event.event.messageInfo.identityAddress) | |
Message Dispatch
Event Data | Data Description | Macro | |
|---|---|---|---|
User Id | The Natterbox User Id the message relates to. | $(Payload_Event.event.userId) | |
Text Payload | The contents of the message being sent or received. | $(Payload_Event.event.textPayload) | |
Digital Channel | Address | The address of the digital channel for the conversation, this will be the address that the message is sent from an Agent or the address that the message is sent to from a contact. | $(Payload_Event.event.digitalChannelGroup.digitalChannel.address) |
Channel Type | The channel type the message was sent on. (SMS etc.) | $(Payload_Event.event.digitalChannelGroup.channelType) | |
Identity | Address | The address of the identity the message was sent to. | $(Payload_Event.event.identity.address) |
Channel Type | The channel type the message was sent on. (SMS etc.) | $(Payload_Event.event.identity.channelType) | |
Content Disposition | Text Size | The character limit of the message. | $(Payload_Event.event.contentDisposition.textSize) |
Image Count | The amount of images sent in the message. | $(Payload_Event.event.contentDisposition.imageCount) | |
Audio Count | The amount of audio files sent in the message. | $(Payload_Event.event.contentDisposition.audioCount) | |
Video Count | The amount of videos sent in the message. | $(Payload_Event.event.contentDisposition.videoCount) | |
Other Count | The amount of other types of files sent in the message. | $(Payload_Event.event.contentDisposition.otherCount) | |
Wrap-Up Events
Event Data | Data Description | Macro | |
|---|---|---|---|
Created Date | The created date of the Wrap-Up. | $(Payload_Event.event.createdDate) | |
Modified Date | The date the Wrap-Up was last modified. | $(Payload_Event.event.modifiedDate) | |
Start Date | The date of the first message in the Wrap-Up. | $(Payload_Event.event.startDate) | |
End Date | The date of the last message in the Wrap-Up. | $(Payload_Event.event.endDate) | |
Subject | The subject of the Wrap-Up. | $(Payload_Event.event.subject) | |
Notes | The notes on the Wrap-Up. | $(Payload_Event.event.notes) | |
Statistics | All Sent Total | The total sent messages in the Wrap-Up. | $(Payload_Event.event.statistics.allSentTotal) |
Text Messages Sent | The total text messages sent in the Wrap-Up. | $(Payload_Event.event.statistics.textMessagesSemt) | |
Audio Sent | The total audio files sent in the Wrap-Up. | $(Payload_Event.event.statistics.audiosSent) | |
Images Sent | The total images sent in the Wrap-Up. | $(Payload_Event.event.statistics.imagesSent) | |
Videos Sent | The total videos sent in the Wrap-Up. | $(Payload_Event.event.statistics.videosSent) | |
All Received Total | The total messages received in the Wrap-Up. | $(Payload_Event.event.statistics.allReceivedTotal) | |
Text Messages Received | The total text messages received in the Wrap-Up. | $(Payload_Event.event.statistics.textReceived) | |
Audio Received | The total audio files received in the Wrap-Up. | $(Payload_Event.event.statistics.audiosReceived) | |
Images Received | The total images received in the Wrap-Up. | $(Payload_Event.event.statistics.imagesReceived) | |
Videos Received | The total videos received in the Wrap-Up. | $(Payload_Event.event.statistics.videosReceived) | |
Average User Response | The average response time of the User in the Wrap-Up. | $(Payload_Event.event.statistics.averageUserResponseSeconds) | |
Average Contact Response | The average response time of the Contact in the Wrap-Up. | $(Payload_Event.event.statistics.averageContactResponseSeconds) | |