Acoustic Exchange has identified and defined recognized events that typically happen when customers use their mobile devices to interact with a business.
As an endpoint publisher, call https://api-01.ubx.ibmmarketingcloud.com/v1/event to publish the event. The following example illustrates a typical JSON payload. This example is based on the Application Install event.
POST v1/event { “channel” : “mobile”, “identifiers” : [ { “name” : “userId”, “value” : “ub0N4DZ5678NW” } ], “events” : [ { “code” : “application/installed”, “timestamp” : “2015-03-07T20:14:12Z”, “attributes” : [ { “name” : “eventName”, “value” : “App Install”, “type” : “string” } { “name” : “appKey”, “value” : “121779A453”, “type” : “string” } { “name” : “channelId”, “value” : “MB10074354692”, “type” : “string” } { “name” : “description”, “value” : “Front of the Line Tix app”, “type” : “string” } ] } ] }
Application install
Information that relates to an individual installing a mobile app on a mobile device. The app is installed and the app registration information is received.
Event code: application/installed
Identifier: userId
Event attributes
Attribute Name | Data Type | Example | Description | Required |
---|---|---|---|---|
description | string | <description> | Description of the published event. Allow Acoustic Exchange users to understand the event context. | |
eventId | string | <value> | Unique ID to identify the type of event and enable lookup in the system. | |
eventName | string | App Install | Name of the event as it appears in the Acoustic Exchange user interface. | Yes |
appKey | string | <value> | Application Key or channel qualifier. | Yes |
channelId | string | <value> | Channel ID. Along with user ID, it represents the destination. | Yes |
Application uninstall
Information that relates to an individual removing an app from a mobile device. Apple or Google informs Acoustic Exchange that the is no longer reachable by push. This might be due to uninstalling the mobile app.
Event code: application/unregistered
Event attributes
Attribute Name | Data Type | Example | Description | Required |
---|---|---|---|---|
description | string | <description> | Description of the published event. Allow Acoustic Exchange users to understand the event context. | |
eventId | string | <value> | Unique ID to identify the type of event and enable lookup in the system. | |
eventName | string | App Uninstall | Name of the event as it appears in the Acoustic Exchange user interface. | Yes |
appKey | string | <value> | Application Key or channel qualifier. | Yes |
channelId | string | <value> | Channel ID. Along with user ID, it represents the destination. | Yes |
Application session start
Information that describes what happens when the mobile user opens the application for the first time in a configurable number of minutes.
Event code: application/sessionStarted
Event attributes
Attribute Name | Data Type | Example | Description | Required |
---|---|---|---|---|
description | string | <description> | Description of the published event. Allow Acoustic Exchange users to understand the event context. | |
eventId | string | <value> | Unique ID to identify the type of event and enable lookup in the system. | |
eventName | string | App Session Start | Name of the event as it appears in the Acoustic Exchange user interface. | Yes |
appKey | string | <value> | Application Key or channel qualifier. | Yes |
channelId | string | <value> | Channel ID. Along with user ID, it represents the destination. | Yes |
Application session end
Information to describe when the mobile user session ends.
Event code: application/sessionEnded
Event attributes
Attribute Name | Data Type | Example | Description | Required |
---|---|---|---|---|
description | string | <description> | Description of the published event. Allow Acoustic Exchange users to understand the event context. | |
eventId | string | <value> | Unique ID to identify the type of event and enable lookup in the system. | |
eventName | string | App Session End | Name of the event as it appears in the Acoustic Exchange user interface. | Yes |
appKey | string | <value> | Application Key or channel qualifier. | Yes |
channelId | string | <value> | Channel ID. Along with user ID, it represents the destination. | Yes |
Application notification push enabled
Information to describe when the mobile user session ends.
Event code: application/sessionEnded
Event attributes
Attribute Name | Data Type | Example | Description | Required |
---|---|---|---|---|
description | string | <description> | Description of the published event. Allow Acoustic Exchange users to understand the event context. | |
eventId | string | <value> | Unique ID to identify the type of event and enable lookup in the system. | |
eventName | string | App Session End | Name of the event as it appears in the Acoustic Exchange user interface. | Yes |
appKey | string | <value> | Application Key or channel qualifier. | Yes |
channelId | string | <value> | Channel ID. Along with user ID, it represents the destination. | Yes |
Application notification push disabled
Information that describes what happens when an APNS user has used the application settings to opt out of receiving push notifications.
Event code: application/uiPushDisabled
Event attributes
Attribute Name | Data Type | Example | Description | Required |
---|---|---|---|---|
description | string | <description> | Description of the published event. Allow Acoustic Exchange users to understand the event context. | |
eventId | string | <value> | Unique ID to identify the type of event and enable lookup in the system. | |
eventName | string | App Push Opt Out | Name of the event as it appears in the Acoustic Exchange user interface. | Yes |
appKey | string | <value> | Application Key or channel qualifier. | Yes |
channelId | string | <value> | Channel ID. Along with user ID, it represents the destination. | Yes |
Application opened
Information to describe what happens when a mobile user clicks in a simple notification to open an app.
Event code: simpleNotification/appOpened
Event attributes
Attribute Name | Data Type | Example | Description | Required |
---|---|---|---|---|
description | string | <description> | Description of the published event. Allow Acoustic Exchange users to understand the event context. | |
eventId | string | <value> | Unique ID to identify the type of event and enable lookup in the system. | |
eventName | string | App Open | Name of the event as it appears in the Acoustic Exchange user interface. | Yes |
appKey | string | <value> | Application Key or channel qualifier. | Yes |
channelId | string | <value> | Channel ID. Along with user ID, it represents the destination. | Yes |
Application click
Information to describe what happens when a mobile user clicks a button in a simple notification, providing the mobile OS with a URL to be handled. This typically happens when the user opens a browser on a mobile device.
Event code: simpleNotification/urlClicked
Event attributes
Attribute Name | Data Type | Example | Description | Required |
---|---|---|---|---|
description | string | <description> | Description of the published event. Allow Acoustic Exchange users to understand the event context. | |
eventId | string | <value> | Unique ID to identify the type of event and enable lookup in the system. | |
eventName | string | Simple notification link click | Name of the event as it appears in the Acoustic Exchange user interface. | Yes |
appKey | string | <value> | Application Key or channel qualifier. | Yes |
channelId | string | <value> | Channel ID. Along with user ID, it represents the destination. | Yes |
Application rich content opened
Information that describes what happens when a mobile user clicks a link to open rich
content.
Event code: simpleNotification/richContentOpened
Event attributes
Attribute Name | Data Type | Example | Description | Required |
---|---|---|---|---|
description | string | <description> | Description of the published event. Allow Acoustic Exchange users to understand the event context. | |
eventId | string | <value> | Unique ID to identify the type of event and enable lookup in the system. | |
eventName | string | Open Rich Content | Name of the event as it appears in the Acoustic Exchange user interface. | Yes |
appKey | string | <value> | Application Key or channel qualifier. | Yes |
channelId | string | <value> | Channel ID. Along with user ID, it represents the destination. | Yes |
Application phone number click
Information that relates to a mobile user who clicks a link to open a phone dialer.
Event code: simpleNotification/phoneNumberClicked
Event attributes
Attribute Name | Data Type | Example | Description | Required |
---|---|---|---|---|
description | string | <description> | Description of the published event. Allow Acoustic Exchange users to understand the event context. | |
eventId | string | <value> | Unique ID to identify the type of event and enable lookup in the system. | |
eventName | string | Open Phone Dialer | Name of the event as it appears in the Acoustic Exchange user interface. | Yes |
appKey | string | <value> | Application Key or channel qualifier. | Yes |
channelId | string | <value> | Channel ID. Along with user ID, it represents the destination. | Yes |
Application unspecified click
Information that relates to a mobile user who clicks a button in a simple notification whose behavior has been defined by the app developer.
Event code: simpleNotification/<unspecified>
Event attributes
Attribute Name | Data Type | Example | Description | Required |
---|---|---|---|---|
description | string | <description> | Description of the published event. Allow Acoustic Exchange users to understand the event context. | |
eventId | string | <value> | Unique ID to identify the type of event and enable lookup in the system. | |
eventName | string | App Custom Action | Name of the event as it appears in the Acoustic Exchange user interface. | Yes |
appKey | string | <value> | Application Key or channel qualifier. | Yes |
channelId | string | <value> | Channel ID. Along with user ID, it represents the destination. | Yes |
Mobile Push notification sent
nformation that describes a mobile push notification associated with a product or brand being sent to a customer.
Event code: mobilePushSend
Event attributes
Attribute Name | Data Type | Example | Description | Required |
---|---|---|---|---|
description | string | <description> | Description of the published event to allow the user to better understand the context of the event. | |
eventId | string | 12345 | Unique ID to identify the type of event and enable lookup in the system. | |
eventName | string | Mobile Push Send | Name of the event as it appears in the Acoustic Exchange user interface. | Yes |
appKey | string | <value> | Application Key or channel qualifier. | Yes |
messageId | <value> | The unique identifier of the sent message associated with the event. | ||
pushType | string | inbox | The type of push notification a contact received. This can be a simple inbox or rich message, in-app, or even the extension name. | |
reportId | string | <value> | The ID associated with the with the push notification. | |
appKey | string | <value> | The application key or the channel qualifier. | |
channelId | string | <value> | Channel ID. Along with user ID, it represents the destination. | Yes |
campaignName | string | Spring Campaign | The name of the marketing campaign associated with the push notification. |