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.

POST <endpoint URL>/v1/events
{
   “provider” : “<string>”,
   "source" : "<string>",
   “channel” : “<string>”,
   “x1id” : “<string>”,
   “identifiers” : 
   [
      {
      “name” : “<string>”,
      “value” : “<string>”,
      "isOriginal" : <boolean> 
      },
   ],
   “events” : 
   [
      {
      “code” : “<string>”,
      "namespace" : "<string>",
      "version" : "<integer>"
      “timestamp” : “<time>”,
      “attributes” : 
      [
         {
         “name” : “<string>”, 
         “value” : “<value>”, 
         “type” : “<type>” 
         } ,
      ]
      }
   ]
}  

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.

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.

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.