Acoustic Exchange requires that you define specific attributes for all published events. Acoustic Exchange might appoint more attribute requirements contingent on the event type or on a specific event.
Acoustic Exchange requires that you define the following attributes for all published events, including Acoustic Exchange recognized events and custom events.
- channel Where the event was observed.
- name Name of the type of identifier that is used to identify the individual or entity that initiated the event. For example, emailAddress.
- value The identifier value for the specific event that is being published by the endpoint.
- code The event code that Acoustic Exchange assigned to the event. Acoustic Exchange assigns a unique event code to recognized and custom events.
- Timestamp The date and time when the event was observed. The time must be submitted in ISO-8601 format.
For example, for social event publishers, unique user identifiers such as User ID, User Name (Facebook and Instagram), Twitter Handle, Twitter ID (Twitter), are required attributes that you define as identifiers during endpoint registration and include when you publish events from the endpoint.
The following example illustrates the structure of the JSON payload in the call to v1/event to publish an event.
JSON | Required | Description |
---|---|---|
|
YES |
The type of device or method that the individual uses to interact with the business or service provider. For example, mobile if the customer used a cell phone. Email, if the customer made an email request. |
|
Required for Individual events. | One or more unique name-value pairs that can be associated with a specific individual and only that individual. |
|
YES |
Acoustic Exchangedefines the event code to identify the specific event. You must use the Acoustic Exchange event code. Do not create a different one. The time stamp indicates when the event was observed by the publishing endpoint, not when the endpoint transmits the event notification. The format must be ISO-8601. |
|
The list of attributes that describe the event. The attributes that are included in the JSON package depend on the event. The attributes section must contain values for all required attributes for the event. You can add other attributes, depending on the information that the business application can gather and report. |
Comments
0 comments
Article is closed for comments.