An event is a specific interaction or behavior that a business application can detect at a specific time and that can be associated with a customer identifier.
Acoustic Exchange recognizes various common events that occur in multiple channels. For example, for commercial websites, Acoustic Exchange recognizes Cart Abandonment as a distinct type of event. For mobile engagements, Acoustic Exchange recognizes when an individual installs a mobile app on a mobile phone. For email communications, an event is generated when the recipient clicks a link in the email message.
Acoustic Exchange can also process consolidated actions that are not related to a specific individual.
You subscribe to an event by first selecting one of the published event types, and then selecting a destination endpoint that subscribes to the event. When the event publisher endpoint detects an event, it sends the event data to Acoustic Exchange. In turn, Acoustic Exchange sends the event data to one or more endpoints that subscribe to the event. It is important to note that an endpoint cannot be both a publisher and subscriber. It must be one or the other.
Acoustic Exchange endpoints register the event types that they support with Acoustic Exchange. In the Acoustic Exchange interface, each endpoint lists the types of events that it publishes. Only registered event types appear as options in Acoustic Exchange.
Acoustic Exchange provides the Dynamic Event Library to give an interactive view of the event publishers that are currently available in the Acoustic Exchange ecosystem. You can use the library to see the event types and event attributes that each publisher supports.
Event types
Acoustic Exchange recognizes a wide range of different types of events that describe interactions with various channels and business solutions. Acoustic Exchange refers to the event types that it supports as recognized events.
During integration with Acoustic Exchange, endpoint providers indicate the types of events that they can support. The providers can also supply details about the event attributes that they support for each type of event. The event attributes represent the types of information that the event publisher includes with the event data that it sends, or that subscribers are prepared to receive.
You can view your current event subscriptions on the Events tab in Acoustic Exchange. In the Table view, event subscriptions display a link to event details that describe the event and event attributes that are contained in the event.
Acoustic Exchange provides the Dynamic Event Library as an interactive tool that you can use to find and examine the various recognized event types that Acoustic Exchange supports. The library organizes the list of recognized event by category and by name.
The library also enables you see which Acoustic Exchange partners provide endpoints that support event subscription as either a publisher or subscriber.
Web events
Acoustic Exchange has identified and defined recognized events that typically happen during interactions that occur while customers use web-based systems. Web events usually describe interactions that occur during visits to a web site.
As an endpoint publisher, call api-exchange-us-1.goacoustic.com/v1/event to publish the event. The following example illustrates a typical JSON payload for the API call. This example is based on the Cart Abandonment event.
POST v1/event
{
“channel” : “web”,
“identifiers” : [
{
“name” : “cookieId”,
“value” : “455739626”
}
],
“events” : [
{
“code” : “ibmcartAbandonment”,
“timestamp” : “2015-09-28T20:15:12Z”,
“attributes” : [
{
“name” : “eventName”,
“value” : “Aggregate Cart Abandonment”,
“type” : “string”
}
{
“name” : “interactionId”,
“value” : “1238953”,
“type” : “string”
}
{
“name” : “quantity”,
“value” : “4”,
“type” : “integer”
}
{
“name” : “currency”,
“value” : “euro”,
“type” : “string”
}
{
“name” : “orderTotal”,
“value” : “525.00”,
“type” : “integer”
}
]
}
]
}
Email events
Acoustic Exchange has identified and defined recognized events that often happen during email exchanges.
As an endpoint publisher, call https://api-exchange-us-1.goacoustic.com/v1/event to publish the event. The following example illustrates a typical JSON payload. This example is based on the Email Open event.
POST v1/event
{
“channel” : “Email”,
“identifiers” : [
{
“name” : “email”,
“value” : “jdoe@example.com”
}
],
“events” : [
{
“code” : “emailOpen”,
“timestamp” : “2015-06-14T20:11:12Z”,
“attributes” : [
{
“name” : “eventName”,
“value” : “Email Open”,
“type” : “string”
}
{
“name” : “messageId”,
“value” : “1211943”,
“type” : “string”
}
{
“name” : “subjectLine”,
“value” : “Please come back!”,
“type” : “string”
}
{
“name” : “mailingtemplateId”,
“value” : “GN8ntGD”,
“type” : “string”
}
]
}
]
}
Mobile events
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-exchange-us-1.goacoustic.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”
}
]
}
]
}
SMS events
Acoustic Exchange defines several recognized events for SMS messaging.
- Message sent from an SMS program An indication that an SMS message was sent, including carrier and delivery status.
- Interacted with an SMS program An indication that an SMS message recipient responded to your text.
- Interacted with a multi-step SMS program An indication that a message recipient engaged with a multi-step SMS program.
- Clicked a link in an SMS An indication that a message recipient selected a link in an SMS.
Social events
Acoustic Exchange has identified and defined recognized events that typically happen as customers interact with businesses over social media.
As an endpoint publisher, call https://api-exchange-us-1.goacoustic.com/v1/event to publish the event. The following example illustrates a typical JSON payload. This example is based on the Facebook Post event.
POST v1/event
{
“channel” : “Social”,
“identifiers” : [
{
“name” : “email”,
“value” : “jdoe@example.com”
}
],
“events” : [
{
“code” : “x1fbPost”,
“timestamp” : “2015-11-03T21:14:12Z”,
“attributes” : [
{
“name” : “eventName”,
“value” : “Facebook Post”,
“type” : “string”
}
{
“name” : “body”,
“value” : “<text body of the post>”,
“type” : “string”
}
{
“name” : “sentimentScore”,
“value” : “3”,
“type” : “integer”
}
{
“name” : “sentiment”,
“value” : “negative”,
“type” : “string”
}
]
}
]
}
Custom events
If Acoustic Exchange recognized events do not adequately describe the event data that an endpoint can provide, the endpoint can define a custom event.
Endpoints that define custom events typically define custom event attributes. However, the endpoint must use caution when it defines an event code for a custom event. Event publishers cannot use an event code that is already used by an Acoustic Exchange recognized event. To avoid potential confusion and errors, consult with Acoustic Exchange before defining a custom event.
Endpoints that subscribe to custom events must consult with the event publisher to determine the event attributes that they can expect.
Event publishers cannot add custom event attributes to an Acoustic Exchange recognized event.
Manage event syndication
Event syndication defines all of the actions that are required to share data between two separate business applications through Exchange.
Event syndication is a 2-step process.
Register endpoints. You register one endpoint to publish event data and at least one other endpoint to receive event data as a subscriber. An event publisher can share event data with multiple event subscribers.
Subscribe to events. Configure event subscriptions between endpoints.
You can manage event syndication in Acoustic Exchange by configuring syndication rules. Syndication rules can be used to filter events so that only events with specific attributes are sent.
Managing your event syndications gives you the ability to process only the event data that you find useful for your particular business needs.
On the Events tab, there are two ways that you can view event syndications in Acoustic Exchange, the Path view and the Table view. The Table view is a list of the event syndications between individual endpoints. It provides a detailed view of each event syndication in your Acoustic Exchange account. The Path view is a graphical representation of the event syndications that you configure between publishing endpoints and event destinations. It provides a visual overview of syndications across your Acoustic Exchange account.
- You can manage event syndications by using either of the two views of the Events tab.
- On the Events tab, if you are using the Path view of the Events tab.
- Find syndication that you want to manage and select the line linking the two together. The line represents the syndication between the two endpoints.
- Click the number at the center of the connecting line. The number indicates the number of event types that the endpoints are subscribed to.
- On the Syndication details menu, select See event details.
- Under the Event type heading, find the event type that you want to manage, and select it.
- Select Manage syndication.
- Continue to Step 2.
- On the Events tab, if you are using the Table view
- Find the Event type, Publisher, and Destination you want to manage.
- Select the Actions menu.
- Select Manage syndication.
- On the Manage syndication tab, select Set syndication rules.
- Define rules by selecting attributes, operators, and values. Each value must appear on a separate line. After adding a value, press Enter to start a new line. To add an attribute to the ruleset, select the Add rule icon.
When you subscribe endpoints to high volume event types in Acoustic Exchange, sometimes not all of the data that is shared is useful. For example, an enterprise website often generates a high volume of user activity, such as page views. An enterprise might consider only the landing page and check-out page view data to be valuable for an advertising campaign. So, in this case, they need to share landing page and check-out page view data with their advertising campaign platform through Acoustic Exchange. However, when they subscribed their advertising campaign endpoint to a page view event, the endpoint received all page view data from the website.
To ensure that the advertising campaign endpoint only receives useful page view event data, an enterprise marketer can configure event syndication rules so that only events with landing page or check-out page view attributes are shared with advertising campaign endpoint.
Organize your view of event syndications
The Events tab provides several ways to sort event syndications that you have defined in your Acoustic Exchange account. The Path view and Table view provide different organization options.
If you define a large number of syndications, sorting the Path view or the Table view can make it easier to find and manage individual syndications. Sorting options in both views also make it possible to organize your syndications according to various characteristics.
- In the Path view, select one of the following sorting options.
- Sort by Path. Provides the simplest visual representation of event syndication by arranging endpoints to minimize the number of syndication paths that overlap and intersect.
- Sort by Endpoint name. List publisher and destination endpoints alphabetically, in descending order. The fastest way to locate a specific endpoint.
- Sort by Provider name. List event publishers alphabetically, in descending order. The fastest way to locate a specific event provider.
- In the Table view, click the top of any column to sort the contents of the column alphabetically in descending or ascending order.