Event attributes

Every event that you publish to Acoustic Exchange must define attributes that describe the event. The number and quality of attributes that you include in the event can improve the value of the event notification to event subscribers and Acoustic Exchange users.

When an endpoint publishes an event, the call to v1/event typically includes several event attributes. Each attribute specifies a name, value, and data type. The attributes in the event notification must include required attributes. The event notification might also include certain recommended attributes that are considered best practice attributes. The publishing endpoint might also include other attributes that Acoustic Exchange considers general attributes.

Acoustic Exchange requires specific event attributes to distinguish between events, facilitate identity enhancement by the Acoustic Exchange Identity Service, and to properly represent the event in the Acoustic Exchange user interface. Some descriptive attributes of published events, specifically, the event code and event name, are defined when an endpoint registers the event with Acoustic Exchange.

Acoustic Exchange reserves specific property names for recognized events. When you register and publish a recognized event, use only the reserved property names.