After Acoustic Exchange receives and evaluates published events, it sends event data in an HTTP POST to endpoints that subscribe to the events. The POST is sent to the URL that the subscribing endpoint provided during endpoint registration.
Summary
Acoustic Exchange includes the following information in the JSON payload of the push message.
- Name of the event provider.
- Name of the endpoint that published the event.
- The channel where the event occurred.
- The x1Id that is associated with the individual that initiated the event.
- All of the identifiers that are associated with the x1Id.
- The event code.
- A timestamp that indicates when the event occurred.
- Attributes that describe the event.
JSON structure
The JSON payload that Acoustic Exchange sends to the subscribing endpoint is structured as follows.
The endpoint URL is the URL that was specified in the v1/endpoint API request to register the endpoint.
|
Authentication requirement
Acoustic Exchange does not include authentication information in the push message.
Acoustic Exchange indicates where the event occurred
In the event data, Acoustic Exchange defines properties to identify the event provider, endpoint, and channel that reported the event.
Property | Included | Data Type | Valid Value | Description |
---|---|---|---|---|
provider | Yes | String | Registered provider. | The name of the organization that registered the publishing endpoint. The provider name displays in the user interface as the Provider. Example: “Acoustic” |
source | Yes | String | Registered endpoint | The name of the endpoint that published the event. Example: "Mobile Customer Engagement". |
channel | Optional | String | As defined by your business systems | The method or device that was used to perform the event. |
Acoustic Exchange indicates who performed the event
When it posts event notification data, Acoustic Exchange provides as much information as possible to identify the specific individual who initiated the event. Under identifiers, Acoustic Exchange defines one or more attributes that identify the specific individual who initiated the event. The list of identifiers includes any additional identifiers that Acoustic Exchange discovered for the individual and merged into the x1Id record.
Property | Included | Data Type | Valid Value | Description |
---|---|---|---|---|
x1id | Yes | String | x1id | The x1Id value that Acoustic Exchange assigns to the individual who triggered the event. |
name | Yes | String | As defined by your business systems | The name of the identifier. Example: loginID |
value | Yes | String | As received | Specific to the individual. Example: jsmith@example.com |
isOriginal | Optional | Boolean |
true false |
true: the identifier is provided by the event publisher. false: the identifier is one that Exchange matched to the event. |
Acoustic Exchange describes the event
Under events, Acoustic Exchange defines several properties that describe the event and when the event occurred. Under attributes, Acoustic Exchange provides values that were observed during the event. The attributes are those that are associated with the event when the endpoint provider registered the event with Acoustic Exchange.
Property | Included | Data Type | Valid Value | Description |
---|---|---|---|---|
code | Required | String | As registered with Exchange | The value that was submitted during event registration. Example: ibmcartPurchase. |
namespace | Optional | String | ||
version | Optional | Integer | Integer greater than 0 | |
timestamp | Required | String | Time, in ISO-8601 format. | Example: 2015-02-28T20:16:12Z. |
name | Required | String | As registered with Exchange | Example: orderTotal. |
value | Required | String | As received. |
The value that was entered during the event. Always passed as a string. The subscribing application must be able to recognize and convert the string. Example: 125.53. |
type | Required | String |
String Number Boolean Time in ISO-8601 format |
The type of data that is provided by the event. Example: number |